Back to top

RLAX - Underwriting Exposure API

Getting Started

For a primer on Getting Started with this API Portal, please view the following 2-minute video:


Authentication

This API uses JSON Web Tokens for its authentication.

The parameters that are needed to be sent for this type of authentication are as follows:

  • JWTHeaderName

  • JWTAcquireURL

  • JWTDestroyURL

Account

Accounts Analyses By Id

getAnalysesResults
GET/accounts/{id}/analyses{?datasource,sort,limit,offset}

Retrieves analyses for account specified by its ID.

Example URI

GET /api/v1/accounts/id/analyses?datasource=&sort=&limit=&offset=
URI Parameters
HideShow
id
number (required) 

ID number of the account.

datasource
string (optional) 

Name of the data source.

sort
string (optional) 

Specify ‘ASC’ to display the results in alphabetical or numerical ascending order or ‘DESC’ to display the results in descending order.

limit
number (optional) 

Maximum number of retrieved records to display on the page.

offset
number (optional) 

Number of the page displaying the returned records, starting at ‘0’.

Response  200
HideShow

OK. Analyses for exposure successfully retrieved.

Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "name": "Hello, world!",
    "runDate": "Hello, world!",
    "description": "Hello, world!",
    "currency": "Hello, world!",
    "type": 1,
    "exposureType": 1,
    "peril": "Hello, world!",
    "status": 1,
    "region": "Hello, world!",
    "engineVersion": "Hello, world!",
    "groupType": "Hello, world!",
    "cedant": "Hello, world!",
    "lob": "Hello, world!",
    "engineType": 1,
    "subperil": 1,
    "exposureId": 1,
    "dataSource": "Hello, world!"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Accounts Countries By Id

getCountriesByAccount
GET/accounts/{id}/countries{?datasource}

Gets list of countries covered by an account specified by its ID.

Example URI

GET /api/v1/accounts/id/countries?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the account.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK. List of countries retrieved.

Headers
Content-Type: application/json
Body
[
  {
    "locationCount": 1,
    "country": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Accounts Coordinates By Id

getCoordinatesByAccount
GET/accounts/{id}/coordinates{?datasource}

Retrieves a list of location coordinates for an account specified by its ID.

Example URI

GET /api/v1/accounts/id/coordinates?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the account.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK. List of location coordinates retrieved.

Headers
Content-Type: application/json
Body
[
  {
    "locationId": 1,
    "locationNumber": "Hello, world!",
    "latitude": 1,
    "longitude": 1,
    "streetAddress": "Hello, world!",
    "geoResolutionCode": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Accounts Geocode By Id

geocodeAccount
POST/accounts/{id}/geocode{?datasource}

Places an accounts into a Geocode queue, where it waits until the geocoding occurs.

Example URI

POST /api/v1/accounts/id/geocode?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the account.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "empty": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "empty": {
      "type": "boolean"
    }
  }
}
Response  202

Accounts Enhancedbuildingattributes

updateBuildingAttributesForAccount
PUT/accounts/{id}/enhancedbuildingattributes{?datasource}

Update building attributes information for an account specified by its ID.

Example URI

PUT /api/v1/accounts/id/enhancedbuildingattributes?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the account.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "updateUnknownOnly": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "updateUnknownOnly": {
      "type": "boolean"
    }
  }
}
Response  200
HideShow

OK. Building attributes updated.

Headers
Content-Type: application/json
Body
"Hello, world!"
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "string"
}

Accounts Surplustreatieslocation By Id

getLocationSurplusTreaties
GET/accounts/{id}/surplustreatieslocation{?datasource}

Retrieves location level surplus treaties for an account specified by its ID.

Example URI

GET /api/v1/accounts/id/surplustreatieslocation?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the account.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK. Location level surplus treaties retrieved.

Headers
Content-Type: application/json
Body
[
  {
    "treatyId": 1,
    "treatyNumber": "Hello, world!",
    "treatyName": "Hello, world!",
    "cedant": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "producer": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "treatyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "currency": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "attachBasis": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "attachLevel": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "premium": 1,
    "occurLimit": 1,
    "attachPt": 1,
    "riskLimit": 1,
    "retentAmt": 1,
    "pcntPlaced": 1,
    "effectDate": "Hello, world!",
    "expireDate": "Hello, world!",
    "pcntRetent": 1,
    "pcntRiShare": 1,
    "pcntCovered": 1,
    "priority": 1,
    "numOfReinst": 1,
    "reinstCharge": 1,
    "maolAmount": 1,
    "isValid": true,
    "userId1": "Hello, world!",
    "userId2": "Hello, world!",
    "lobs": [
      {
        "id": 1,
        "name": "Hello, world!"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Accounts Sites By Id

getSiteNames
GET/accounts/{id}/sites{?datasource}

Retrieves a list of site names for an account specified by its ID.

Example URI

GET /api/v1/accounts/id/sites?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the account.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK. List of site names retrieved.

Headers
Content-Type: application/json
Body
[
  "Hello, world!"
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Accounts Validate By Id

validateAccount
GET/accounts/{id}/validate{?datasource}

Retrieves validation on an account specified by its ID.

Example URI

GET /api/v1/accounts/id/validate?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the account.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK. Validation retrieved.

Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "name": "Hello, world!",
    "number": "Hello, world!",
    "status": "Hello, world!",
    "cedant": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "producer": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "underwriter": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "branch": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "userId1": "Hello, world!",
    "userId2": "Hello, world!",
    "userId3": "Hello, world!",
    "userId4": "Hello, world!",
    "userText1": "Hello, world!",
    "userText2": "Hello, world!",
    "createDate": "Hello, world!",
    "stampDate": "Hello, world!",
    "state": "InActive",
    "linkId": "Hello, world!",
    "guid": "Hello, world!",
    "isValid": true,
    "CustomData": "Hello, world!"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Accounts By Id

getAccount
GET/accounts/{id}{?datasource}

Retrieves information on an account specified by its ID.

Example URI

GET /api/v1/accounts/id?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the account.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK. Account information successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "number": "Hello, world!",
  "status": "Hello, world!",
  "cedant": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "producer": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "underwriter": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "branch": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "userId1": "Hello, world!",
  "userId2": "Hello, world!",
  "userId3": "Hello, world!",
  "userId4": "Hello, world!",
  "userText1": "Hello, world!",
  "userText2": "Hello, world!",
  "createDate": "Hello, world!",
  "stampDate": "Hello, world!",
  "state": "InActive",
  "linkId": "Hello, world!",
  "guid": "Hello, world!",
  "isValid": true,
  "CustomData": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "number": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "cedant": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "producer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "underwriter": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "branch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "userId1": {
      "type": "string"
    },
    "userId2": {
      "type": "string"
    },
    "userId3": {
      "type": "string"
    },
    "userId4": {
      "type": "string"
    },
    "userText1": {
      "type": "string"
    },
    "userText2": {
      "type": "string"
    },
    "createDate": {
      "type": "string"
    },
    "stampDate": {
      "type": "string"
    },
    "state": {
      "type": "string",
      "enum": [
        "InActive",
        "Active"
      ]
    },
    "linkId": {
      "type": "string"
    },
    "guid": {
      "type": "string"
    },
    "isValid": {
      "type": "boolean"
    },
    "CustomData": {
      "type": "string"
    }
  }
}

updateAccount
PUT/accounts/{id}{?datasource}

Updates a account specified by its ID with new information.

Example URI

PUT /api/v1/accounts/id?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the account.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "number": "Hello, world!",
  "status": "Hello, world!",
  "cedant": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "producer": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "underwriter": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "branch": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "userId1": "Hello, world!",
  "userId2": "Hello, world!",
  "userId3": "Hello, world!",
  "userId4": "Hello, world!",
  "userText1": "Hello, world!",
  "userText2": "Hello, world!",
  "createDate": "Hello, world!",
  "stampDate": "Hello, world!",
  "state": "InActive",
  "linkId": "Hello, world!",
  "guid": "Hello, world!",
  "isValid": true,
  "CustomData": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "number": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "cedant": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "producer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "underwriter": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "branch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "userId1": {
      "type": "string"
    },
    "userId2": {
      "type": "string"
    },
    "userId3": {
      "type": "string"
    },
    "userId4": {
      "type": "string"
    },
    "userText1": {
      "type": "string"
    },
    "userText2": {
      "type": "string"
    },
    "createDate": {
      "type": "string"
    },
    "stampDate": {
      "type": "string"
    },
    "state": {
      "type": "string",
      "enum": [
        "InActive",
        "Active"
      ]
    },
    "linkId": {
      "type": "string"
    },
    "guid": {
      "type": "string"
    },
    "isValid": {
      "type": "boolean"
    },
    "CustomData": {
      "type": "string"
    }
  }
}
Response  204

deleteAccount
DELETE/accounts/{id}{?datasource}

Deletes an account specified by its ID.

Example URI

DELETE /api/v1/accounts/id?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the account.

datasource
string (optional) 

Name of the data source.

Response  202

Accounts

searchAccounts
GET/accounts{?datasource,q,sort,limit,offset,portfoliofilter}

Retrieves list of accounts filtered by the specified parameters.

Example URI

GET /api/v1/accounts?datasource=&q=&sort=&limit=&offset=&portfoliofilter=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

q
string (optional) 

Filters applied to the query results.

sort
string (optional) 

Specify ‘ASC’ to display the results in alphabetical or numerical ascending order or ‘DESC’ to display the results in descending order.

limit
number (optional) 

Maximum number of retrieved records to display on the page. value of 0 will only return total account count

offset
number (optional) 

Number of the page displaying the returned records, starting at ‘0’.

portfoliofilter
boolean (optional) 

If This search was triggered from portfoliostarting at ‘0’.

Response  200
HideShow

OK. Validation retrieved.

Headers
Content-Type: application/json
Body
{
  "searchTotalMatch": 1,
  "searchItems": [
    {
      "accountId": 1,
      "accountNumber": "Hello, world!",
      "accountName": "Hello, world!",
      "cedantName": "Hello, world!",
      "producerName": "Hello, world!",
      "underwriterName": "Hello, world!",
      "branchName": "Hello, world!",
      "numLocations": 1,
      "userId1": "Hello, world!",
      "userId2": "Hello, world!",
      "userId3": "Hello, world!",
      "userId4": "Hello, world!",
      "userText1": "Hello, world!",
      "userText2": "Hello, world!",
      "geocodeVersion": "Hello, world!",
      "hazardVersion": "Hello, world!",
      "ownerName": "Hello, world!",
      "updatedBy": "Hello, world!",
      "stampDate": "Hello, world!",
      "jobStatus": "Hello, world!",
      "jobStartDate": "Hello, world!",
      "jobEndDate": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "searchTotalMatch": {
      "type": "number"
    },
    "searchItems": {
      "type": "array"
    }
  }
}

Accounts

createAccount
POST/accounts{?datasource}

Creates a new account in Risk Modeler.

Example URI

POST /api/v1/accounts?datasource=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "number": "Hello, world!",
  "status": "Hello, world!",
  "cedant": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "producer": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "underwriter": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "branch": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "userId1": "Hello, world!",
  "userId2": "Hello, world!",
  "userId3": "Hello, world!",
  "userId4": "Hello, world!",
  "userText1": "Hello, world!",
  "userText2": "Hello, world!",
  "createDate": "Hello, world!",
  "stampDate": "Hello, world!",
  "state": "InActive",
  "linkId": "Hello, world!",
  "guid": "Hello, world!",
  "isValid": true,
  "CustomData": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "number": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "cedant": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "producer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "underwriter": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "branch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "userId1": {
      "type": "string"
    },
    "userId2": {
      "type": "string"
    },
    "userId3": {
      "type": "string"
    },
    "userId4": {
      "type": "string"
    },
    "userText1": {
      "type": "string"
    },
    "userText2": {
      "type": "string"
    },
    "createDate": {
      "type": "string"
    },
    "stampDate": {
      "type": "string"
    },
    "state": {
      "type": "string",
      "enum": [
        "InActive",
        "Active"
      ]
    },
    "linkId": {
      "type": "string"
    },
    "guid": {
      "type": "string"
    },
    "isValid": {
      "type": "boolean"
    },
    "CustomData": {
      "type": "string"
    }
  }
}
Response  201

Accounts Validatemedia By Id

downloadValidationAccountFile
GET/accounts/{id}/validatemedia{?datasource}

Retrieves account validation file specified by account ID

Example URI

GET /api/v1/accounts/id/validatemedia?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the account.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK. Validation retrieved.

Headers
Content-Type: application/json
Body
{}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {}
}

Accounts Copy By Id

copyAccounts
POST/accounts/{id}/copy{?datasource}

Copies existing multiple accounts within Risk Modeler.

Example URI

POST /api/v1/accounts/id/copy?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the account.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "newNum": "Hello, world!",
  "newName": "Hello, world!",
  "linked": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "newNum": {
      "type": "string"
    },
    "newName": {
      "type": "string"
    },
    "linked": {
      "type": "boolean"
    }
  }
}
Response  202

Accounts Move By Id

moveAccount
POST/accounts/{id}/move{?option,datasource}

Moves an account specified by its ID to user edm.

Example URI

POST /api/v1/accounts/id/move?option=&datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the account.

option
number (optional) 

Select whether (‘1’) or not (‘0’) to include locations or not, while moving the account.

datasource
string (optional) 

Name of the data source.

Response  201

Accounts Process By Id

processAccount
POST/accounts/{id}/process

Places an accounts into a queue, where it waits until the analysis occurs.

Example URI

POST /api/v1/accounts/id/process
URI Parameters
HideShow
id
number (required) 

ID number of the account.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "exposureType": "PORTFOLIO",
  "edm": "Hello, world!",
  "currency": {
    "code": "Hello, world!",
    "scheme": "Hello, world!",
    "asOfDate": "Hello, world!",
    "vintage": "Hello, world!"
  },
  "modelProfileId": 1,
  "eventRateSchemeId": 1,
  "outputSetting": {
    "metricRequests": [
      {
        "granularity": [
          "Hello, world!"
        ],
        "metricType": "Hello, world!",
        "perspective": "Hello, world!",
        "includeIntermediateSums": true
      }
    ]
  },
  "treaties": [
    1
  ],
  "outputProfile": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "exposureType": {
      "type": "string",
      "enum": [
        "PORTFOLIO",
        "ACCOUNT",
        "LOCATION",
        "POLICY",
        "TREATY"
      ]
    },
    "edm": {
      "type": "string"
    },
    "currency": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "scheme": {
          "type": "string"
        },
        "asOfDate": {
          "type": "string"
        },
        "vintage": {
          "type": "string"
        }
      }
    },
    "modelProfileId": {
      "type": "number"
    },
    "eventRateSchemeId": {
      "type": "number"
    },
    "outputSetting": {
      "type": "object",
      "properties": {
        "metricRequests": {
          "type": "array"
        }
      }
    },
    "treaties": {
      "type": "array"
    },
    "outputProfile": {
      "type": "string"
    }
  }
}
Response  200
HideShow

OK.

Headers
Content-Type: application/json
Body
{
  "jobIds": [
    1
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "jobIds": {
      "type": "array"
    }
  }
}

Accounts Hazard By Id

runAccountHazard
POST/accounts/{id}/hazard{?datasource}

Places an accounts into a queue, where it waits until the hazard happens.

Example URI

POST /api/v1/accounts/id/hazard?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the account.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "empty": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "empty": {
      "type": "boolean"
    }
  }
}
Response  202

Cedant

Cedants

getCedants
GET/cedants{?datasource,q,sort,limit,offset}

Retrieves a list of the cedants in a specified data source.

Example URI

GET /api/v1/cedants?datasource=&q=&sort=&limit=&offset=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

q
string (optional) 

Filters applied to the query results.

sort
string (optional) 

Specify comma-delimited field names followed by ‘ASC’ (to display the results in alphabetical or numerical ascending order) or ‘DESC’ (to display the results in descending order.)

limit
number (optional) 

Maximum number of retrieved records to display on the page.

offset
number (optional) 

Number of the page displaying the returned records, starting at ‘0’.

Response  200
HideShow

OK. List of cedants in the data source is successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "searchTotalMatch": 1,
  "searchItems": [
    {
      "id": "Hello, world!",
      "name": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "searchTotalMatch": {
      "type": "number"
    },
    "searchItems": {
      "type": "array"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Cedants

createCedant
POST/cedants{?datasource}

Creates new Cedant in a specified data source.

Example URI

POST /api/v1/cedants?datasource=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "Hello, world!",
  "name": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  201
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  409
HideShow

Conflict. Resource already exists.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Cedants By Id

getCedantById
GET/cedants/{id}{?datasource}

Retrieves a cedant by id in a specified data source.

Example URI

GET /api/v1/cedants/id?datasource=
URI Parameters
HideShow
id
string (required) 

ID of the cedant.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK. Cedant by Id in the data source is successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "id": "Hello, world!",
  "name": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  404
HideShow

Cedant not found.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updateCedant
PUT/cedants/{id}{?datasource}

Updates existing Cedant in a specified data source.

Example URI

PUT /api/v1/cedants/id?datasource=
URI Parameters
HideShow
id
string (required) 

ID of the cedant.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "Hello, world!",
  "name": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  404
HideShow

Not found Request. resource not found.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

deleteCedant
DELETE/cedants/{id}{?datasource}

Deletes existing Cedant in a specified data source.

Example URI

DELETE /api/v1/cedants/id?datasource=
URI Parameters
HideShow
id
string (required) 

ID of the cedant.

datasource
string (optional) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  404
HideShow

Not found Request. resource not found.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Policy

Conditions By Id

getPolicyConditionTemplates
GET/conditions/{id}{?datasource}

Retrieves information for a policy condition specified by its ID.

Example URI

GET /api/v1/conditions/id?datasource=
URI Parameters
HideShow
id
number (required) 
datasource
string (required) 

Name of the data source.

Response  200
HideShow

OK. Information for a specified policy condition is successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "isPredefined": true,
  "limit": 1,
  "deductible": 1,
  "deductibleType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "conditionType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "parentCondition": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "policyNumber": "Hello, world!",
  "policyConditionCriterias": [
    {
      "id": 1,
      "logic": "Hello, world!",
      "openPar": "Hello, world!",
      "field": "Hello, world!",
      "operator": "Hello, world!",
      "value": "Hello, world!",
      "closePar": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "isPredefined": {
      "type": "boolean"
    },
    "limit": {
      "type": "number"
    },
    "deductible": {
      "type": "number"
    },
    "deductibleType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "conditionType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "parentCondition": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "policyNumber": {
      "type": "string"
    },
    "policyConditionCriterias": {
      "type": "array"
    }
  }
}

Policies By Id

getPolicy
GET/policies/{id}{?datasource}

Retrieves information on a specified policy by its ID

Example URI

GET /api/v1/policies/id?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

datasource
string (required) 

Name of the data source.

Response  200
HideShow

OK. Information on a specified policy is successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "coverages": [
    {
      "id": 1,
      "peril": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "lossType": "Building",
      "premium": 1,
      "limit": 1,
      "deductible": 1,
      "label": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "accumulation": 1,
      "isValid": true
    }
  ],
  "reinsuranceCessions": [
    {
      "id": 1,
      "name": "Hello, world!",
      "exposureId": 1,
      "exposureType": "POL",
      "type": "None",
      "facReinsurer": {
        "id": "Hello, world!",
        "name": "Hello, world!"
      },
      "treaty": {
        "treatyId": 1,
        "treatyNumber": "Hello, world!",
        "treatyName": "Hello, world!",
        "cedant": {
          "id": "Hello, world!",
          "name": "Hello, world!"
        },
        "producer": {
          "id": "Hello, world!",
          "name": "Hello, world!"
        },
        "treatyType": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "currency": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "attachBasis": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "attachLevel": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "premium": 1,
        "occurLimit": 1,
        "attachPt": 1,
        "riskLimit": 1,
        "retentAmt": 1,
        "pcntPlaced": 1,
        "effectDate": "Hello, world!",
        "expireDate": "Hello, world!",
        "pcntRetent": 1,
        "pcntRiShare": 1,
        "pcntCovered": 1,
        "priority": 1,
        "numOfReinst": 1,
        "reinstCharge": 1,
        "maolAmount": 1,
        "isValid": true,
        "userId1": "Hello, world!",
        "userId2": "Hello, world!",
        "lobs": [
          {
            "id": 1,
            "name": "Hello, world!"
          }
        ]
      },
      "layerNumber": 1,
      "layerAmount": 1,
      "excessAmount": 1,
      "percentReinsurance": 1,
      "maolAmount": 1,
      "priority": 1,
      "isValid": true
    }
  ],
  "policyConditions": [
    {
      "id": 1,
      "name": "Hello, world!",
      "isPredefined": true,
      "limit": 1,
      "deductible": 1,
      "deductibleType": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "conditionType": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "parentCondition": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "policyNumber": "Hello, world!",
      "policyConditionCriterias": [
        {
          "id": 1,
          "logic": "Hello, world!",
          "openPar": "Hello, world!",
          "field": "Hello, world!",
          "operator": "Hello, world!",
          "value": "Hello, world!",
          "closePar": "Hello, world!"
        }
      ]
    }
  ],
  "id": 1,
  "number": "Hello, world!",
  "accountId": 1,
  "lob": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "peril": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "status": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "inceptionDate": "Hello, world!",
  "expirationDate": "Hello, world!",
  "currency": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "partOf": 1,
  "attachmentPoint": 1,
  "minDeductible": 1,
  "maxDeductible": 1,
  "blanketLimit": 1,
  "blanketDeductible": 1,
  "blanketPremium": 1,
  "biLifeLine": 1,
  "deductType": 1,
  "structure": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "coverageBase": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "limitGU": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "userText1": "Hello, world!",
  "userText2": "Hello, world!",
  "userText3": "Hello, world!",
  "userText4": "Hello, world!",
  "isValid": true,
  "CustomData": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "coverages": {
      "type": "array"
    },
    "reinsuranceCessions": {
      "type": "array"
    },
    "policyConditions": {
      "type": "array"
    },
    "id": {
      "type": "number"
    },
    "number": {
      "type": "string"
    },
    "accountId": {
      "type": "number"
    },
    "lob": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "peril": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "status": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "inceptionDate": {
      "type": "string"
    },
    "expirationDate": {
      "type": "string"
    },
    "currency": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "partOf": {
      "type": "number"
    },
    "attachmentPoint": {
      "type": "number"
    },
    "minDeductible": {
      "type": "number"
    },
    "maxDeductible": {
      "type": "number"
    },
    "blanketLimit": {
      "type": "number"
    },
    "blanketDeductible": {
      "type": "number"
    },
    "blanketPremium": {
      "type": "number"
    },
    "biLifeLine": {
      "type": "number"
    },
    "deductType": {
      "type": "number"
    },
    "structure": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "coverageBase": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "limitGU": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "userText1": {
      "type": "string"
    },
    "userText2": {
      "type": "string"
    },
    "userText3": {
      "type": "string"
    },
    "userText4": {
      "type": "string"
    },
    "isValid": {
      "type": "boolean"
    },
    "CustomData": {
      "type": "string"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updatePolicy
PUT/policies/{id}{?datasource}

Updates a policy specified by its ID.

Example URI

PUT /api/v1/policies/id?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "coverages": [
    {
      "id": 1,
      "peril": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "lossType": "Building",
      "premium": 1,
      "limit": 1,
      "deductible": 1,
      "label": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "accumulation": 1,
      "isValid": true
    }
  ],
  "reinsuranceCessions": [
    {
      "id": 1,
      "name": "Hello, world!",
      "exposureId": 1,
      "exposureType": "POL",
      "type": "None",
      "facReinsurer": {
        "id": "Hello, world!",
        "name": "Hello, world!"
      },
      "treaty": {
        "treatyId": 1,
        "treatyNumber": "Hello, world!",
        "treatyName": "Hello, world!",
        "cedant": {
          "id": "Hello, world!",
          "name": "Hello, world!"
        },
        "producer": {
          "id": "Hello, world!",
          "name": "Hello, world!"
        },
        "treatyType": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "currency": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "attachBasis": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "attachLevel": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "premium": 1,
        "occurLimit": 1,
        "attachPt": 1,
        "riskLimit": 1,
        "retentAmt": 1,
        "pcntPlaced": 1,
        "effectDate": "Hello, world!",
        "expireDate": "Hello, world!",
        "pcntRetent": 1,
        "pcntRiShare": 1,
        "pcntCovered": 1,
        "priority": 1,
        "numOfReinst": 1,
        "reinstCharge": 1,
        "maolAmount": 1,
        "isValid": true,
        "userId1": "Hello, world!",
        "userId2": "Hello, world!",
        "lobs": [
          {
            "id": 1,
            "name": "Hello, world!"
          }
        ]
      },
      "layerNumber": 1,
      "layerAmount": 1,
      "excessAmount": 1,
      "percentReinsurance": 1,
      "maolAmount": 1,
      "priority": 1,
      "isValid": true
    }
  ],
  "policyConditions": [
    {
      "id": 1,
      "name": "Hello, world!",
      "isPredefined": true,
      "limit": 1,
      "deductible": 1,
      "deductibleType": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "conditionType": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "parentCondition": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "policyNumber": "Hello, world!",
      "policyConditionCriterias": [
        {
          "id": 1,
          "logic": "Hello, world!",
          "openPar": "Hello, world!",
          "field": "Hello, world!",
          "operator": "Hello, world!",
          "value": "Hello, world!",
          "closePar": "Hello, world!"
        }
      ]
    }
  ],
  "id": 1,
  "number": "Hello, world!",
  "accountId": 1,
  "lob": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "peril": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "status": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "inceptionDate": "Hello, world!",
  "expirationDate": "Hello, world!",
  "currency": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "partOf": 1,
  "attachmentPoint": 1,
  "minDeductible": 1,
  "maxDeductible": 1,
  "blanketLimit": 1,
  "blanketDeductible": 1,
  "blanketPremium": 1,
  "biLifeLine": 1,
  "deductType": 1,
  "structure": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "coverageBase": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "limitGU": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "userText1": "Hello, world!",
  "userText2": "Hello, world!",
  "userText3": "Hello, world!",
  "userText4": "Hello, world!",
  "isValid": true,
  "CustomData": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "coverages": {
      "type": "array"
    },
    "reinsuranceCessions": {
      "type": "array"
    },
    "policyConditions": {
      "type": "array"
    },
    "id": {
      "type": "number"
    },
    "number": {
      "type": "string"
    },
    "accountId": {
      "type": "number"
    },
    "lob": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "peril": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "status": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "inceptionDate": {
      "type": "string"
    },
    "expirationDate": {
      "type": "string"
    },
    "currency": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "partOf": {
      "type": "number"
    },
    "attachmentPoint": {
      "type": "number"
    },
    "minDeductible": {
      "type": "number"
    },
    "maxDeductible": {
      "type": "number"
    },
    "blanketLimit": {
      "type": "number"
    },
    "blanketDeductible": {
      "type": "number"
    },
    "blanketPremium": {
      "type": "number"
    },
    "biLifeLine": {
      "type": "number"
    },
    "deductType": {
      "type": "number"
    },
    "structure": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "coverageBase": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "limitGU": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "userText1": {
      "type": "string"
    },
    "userText2": {
      "type": "string"
    },
    "userText3": {
      "type": "string"
    },
    "userText4": {
      "type": "string"
    },
    "isValid": {
      "type": "boolean"
    },
    "CustomData": {
      "type": "string"
    }
  }
}
Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

deletePolicy
DELETE/policies/{id}{?datasource}

Deletes a policy specified by its ID.

Example URI

DELETE /api/v1/policies/id?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

datasource
string (required) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Policies Copy

copyPolicy
POST/policies/copy{?datasource}

Copies existing policy within Risk Modeler.

Example URI

POST /api/v1/policies/copy?datasource=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    }
  }
}
Response  200
HideShow

OK. Existing policy is successfully copied.

Headers
Content-Type: application/json
Body
{
  "id": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "links": [
    {
      "rel": "Hello, world!",
      "href": "Hello, world!",
      "method": "Hello, world!"
    }
  ],
  "meta": {
    "createdBy": "Hello, world!",
    "createdAt": "Hello, world!",
    "updatedBy": "Hello, world!",
    "updatedAt": "Hello, world!",
    "count": 1
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "links": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        },
        "updatedBy": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        },
        "count": {
          "type": "number"
        }
      }
    }
  },
  "required": [
    "links",
    "meta"
  ]
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Policies Coverage By Id And Coverageid

getPolicyCoverage
GET/policies/{id}/coverage/{coverageid}{?datasource}

Retrieves information for a coverage based on its ID for a policy specified by its ID.

Example URI

GET /api/v1/policies/id/coverage/coverageid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

coverageid
number (required) 

ID number of the Policy Coverage.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK. Information on a specified poliy coverage is successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "peril": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "lossType": "Building",
  "premium": 1,
  "limit": 1,
  "deductible": 1,
  "label": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "accumulation": 1,
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "peril": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "lossType": {
      "type": "string",
      "enum": [
        "Building",
        "Contents",
        "BI",
        "CombinedCvg"
      ]
    },
    "premium": {
      "type": "number"
    },
    "limit": {
      "type": "number"
    },
    "deductible": {
      "type": "number"
    },
    "label": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "accumulation": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updatePolicyCoverage
PUT/policies/{id}/coverage/{coverageid}{?datasource}

Updates a coverage specified by its ID for a policy specified by its ID.

Example URI

PUT /api/v1/policies/id/coverage/coverageid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

coverageid
number (required) 

ID number of the Policy Coverage.

datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "peril": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "lossType": "Building",
  "premium": 1,
  "limit": 1,
  "deductible": 1,
  "label": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "accumulation": 1,
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "peril": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "lossType": {
      "type": "string",
      "enum": [
        "Building",
        "Contents",
        "BI",
        "CombinedCvg"
      ]
    },
    "premium": {
      "type": "number"
    },
    "limit": {
      "type": "number"
    },
    "deductible": {
      "type": "number"
    },
    "label": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "accumulation": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

deletePolicyCoverage
DELETE/policies/{id}/coverage/{coverageid}{?datasource}

Deletes a coverage specified by its ID for a policy specified by its ID.

Example URI

DELETE /api/v1/policies/id/coverage/coverageid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

coverageid
number (required) 

ID number of the Policy Coverage.

datasource
string (required) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Policies Coverage By Id

createPolicyCoverage
POST/policies/{id}/coverage{?datasource}

Creates a coverage for a policy specified by its ID.

Example URI

POST /api/v1/policies/id/coverage?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "peril": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "lossType": "Building",
  "premium": 1,
  "limit": 1,
  "deductible": 1,
  "label": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "accumulation": 1,
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "peril": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "lossType": {
      "type": "string",
      "enum": [
        "Building",
        "Contents",
        "BI",
        "CombinedCvg"
      ]
    },
    "premium": {
      "type": "number"
    },
    "limit": {
      "type": "number"
    },
    "deductible": {
      "type": "number"
    },
    "label": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "accumulation": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  201
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Policies Cession By Id And Cessionid

getPolicyReinsuranceCession
GET/policies/{id}/cession/{cessionid}{?datasource}

Retrieves information for reinsurance cession specified by its ID for a policy specified by its ID.

Example URI

GET /api/v1/policies/id/cession/cessionid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

cessionid
number (required) 

ID number of the Cession.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

Reinsurance cession retrieved.

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "exposureId": 1,
  "exposureType": "POL",
  "type": "None",
  "facReinsurer": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "treaty": {
    "treatyId": 1,
    "treatyNumber": "Hello, world!",
    "treatyName": "Hello, world!",
    "cedant": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "producer": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "treatyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "currency": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "attachBasis": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "attachLevel": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "premium": 1,
    "occurLimit": 1,
    "attachPt": 1,
    "riskLimit": 1,
    "retentAmt": 1,
    "pcntPlaced": 1,
    "effectDate": "Hello, world!",
    "expireDate": "Hello, world!",
    "pcntRetent": 1,
    "pcntRiShare": 1,
    "pcntCovered": 1,
    "priority": 1,
    "numOfReinst": 1,
    "reinstCharge": 1,
    "maolAmount": 1,
    "isValid": true,
    "userId1": "Hello, world!",
    "userId2": "Hello, world!",
    "lobs": [
      {
        "id": 1,
        "name": "Hello, world!"
      }
    ]
  },
  "layerNumber": 1,
  "layerAmount": 1,
  "excessAmount": 1,
  "percentReinsurance": 1,
  "maolAmount": 1,
  "priority": 1,
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "exposureId": {
      "type": "number"
    },
    "exposureType": {
      "type": "string",
      "enum": [
        "POL",
        "LOC"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "None",
        "Facultative",
        "Treaty"
      ]
    },
    "facReinsurer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "treaty": {
      "type": "object",
      "properties": {
        "treatyId": {
          "type": "number"
        },
        "treatyNumber": {
          "type": "string"
        },
        "treatyName": {
          "type": "string"
        },
        "cedant": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "producer": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "treatyType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "currency": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "attachBasis": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "attachLevel": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "premium": {
          "type": "number"
        },
        "occurLimit": {
          "type": "number"
        },
        "attachPt": {
          "type": "number"
        },
        "riskLimit": {
          "type": "number"
        },
        "retentAmt": {
          "type": "number"
        },
        "pcntPlaced": {
          "type": "number"
        },
        "effectDate": {
          "type": "string"
        },
        "expireDate": {
          "type": "string"
        },
        "pcntRetent": {
          "type": "number"
        },
        "pcntRiShare": {
          "type": "number"
        },
        "pcntCovered": {
          "type": "number"
        },
        "priority": {
          "type": "number"
        },
        "numOfReinst": {
          "type": "number"
        },
        "reinstCharge": {
          "type": "number"
        },
        "maolAmount": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        },
        "userId1": {
          "type": "string"
        },
        "userId2": {
          "type": "string"
        },
        "lobs": {
          "type": "array"
        }
      },
      "required": [
        "cedant"
      ]
    },
    "layerNumber": {
      "type": "number"
    },
    "layerAmount": {
      "type": "number"
    },
    "excessAmount": {
      "type": "number"
    },
    "percentReinsurance": {
      "type": "number"
    },
    "maolAmount": {
      "type": "number"
    },
    "priority": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    }
  }
}

updatePolicyReinsuranceCession
PUT/policies/{id}/cession/{cessionid}{?datasource}

Updates a reinsurance cession specified by its ID for a policy specified by its ID.

Example URI

PUT /api/v1/policies/id/cession/cessionid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

cessionid
number (required) 

ID number of the Cession.

datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "exposureId": 1,
  "exposureType": "POL",
  "type": "None",
  "facReinsurer": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "treaty": {
    "treatyId": 1,
    "treatyNumber": "Hello, world!",
    "treatyName": "Hello, world!",
    "cedant": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "producer": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "treatyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "currency": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "attachBasis": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "attachLevel": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "premium": 1,
    "occurLimit": 1,
    "attachPt": 1,
    "riskLimit": 1,
    "retentAmt": 1,
    "pcntPlaced": 1,
    "effectDate": "Hello, world!",
    "expireDate": "Hello, world!",
    "pcntRetent": 1,
    "pcntRiShare": 1,
    "pcntCovered": 1,
    "priority": 1,
    "numOfReinst": 1,
    "reinstCharge": 1,
    "maolAmount": 1,
    "isValid": true,
    "userId1": "Hello, world!",
    "userId2": "Hello, world!",
    "lobs": [
      {
        "id": 1,
        "name": "Hello, world!"
      }
    ]
  },
  "layerNumber": 1,
  "layerAmount": 1,
  "excessAmount": 1,
  "percentReinsurance": 1,
  "maolAmount": 1,
  "priority": 1,
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "exposureId": {
      "type": "number"
    },
    "exposureType": {
      "type": "string",
      "enum": [
        "POL",
        "LOC"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "None",
        "Facultative",
        "Treaty"
      ]
    },
    "facReinsurer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "treaty": {
      "type": "object",
      "properties": {
        "treatyId": {
          "type": "number"
        },
        "treatyNumber": {
          "type": "string"
        },
        "treatyName": {
          "type": "string"
        },
        "cedant": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "producer": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "treatyType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "currency": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "attachBasis": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "attachLevel": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "premium": {
          "type": "number"
        },
        "occurLimit": {
          "type": "number"
        },
        "attachPt": {
          "type": "number"
        },
        "riskLimit": {
          "type": "number"
        },
        "retentAmt": {
          "type": "number"
        },
        "pcntPlaced": {
          "type": "number"
        },
        "effectDate": {
          "type": "string"
        },
        "expireDate": {
          "type": "string"
        },
        "pcntRetent": {
          "type": "number"
        },
        "pcntRiShare": {
          "type": "number"
        },
        "pcntCovered": {
          "type": "number"
        },
        "priority": {
          "type": "number"
        },
        "numOfReinst": {
          "type": "number"
        },
        "reinstCharge": {
          "type": "number"
        },
        "maolAmount": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        },
        "userId1": {
          "type": "string"
        },
        "userId2": {
          "type": "string"
        },
        "lobs": {
          "type": "array"
        }
      },
      "required": [
        "cedant"
      ]
    },
    "layerNumber": {
      "type": "number"
    },
    "layerAmount": {
      "type": "number"
    },
    "excessAmount": {
      "type": "number"
    },
    "percentReinsurance": {
      "type": "number"
    },
    "maolAmount": {
      "type": "number"
    },
    "priority": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

deletePolicyReinsuranceCession
DELETE/policies/{id}/cession/{cessionid}{?datasource}

Deletes a reinsurance cession specified by its ID for a policy specified by its ID.

Example URI

DELETE /api/v1/policies/id/cession/cessionid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

cessionid
number (required) 

ID number of the Cession.

datasource
string (required) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Policies Cession By Id

createPolicyReinsuranceCession
POST/policies/{id}/cession{?datasource}

Creates a reinsurance cession for a policy specified by its ID.

Example URI

POST /api/v1/policies/id/cession?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "exposureId": 1,
  "exposureType": "POL",
  "type": "None",
  "facReinsurer": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "treaty": {
    "treatyId": 1,
    "treatyNumber": "Hello, world!",
    "treatyName": "Hello, world!",
    "cedant": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "producer": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "treatyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "currency": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "attachBasis": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "attachLevel": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "premium": 1,
    "occurLimit": 1,
    "attachPt": 1,
    "riskLimit": 1,
    "retentAmt": 1,
    "pcntPlaced": 1,
    "effectDate": "Hello, world!",
    "expireDate": "Hello, world!",
    "pcntRetent": 1,
    "pcntRiShare": 1,
    "pcntCovered": 1,
    "priority": 1,
    "numOfReinst": 1,
    "reinstCharge": 1,
    "maolAmount": 1,
    "isValid": true,
    "userId1": "Hello, world!",
    "userId2": "Hello, world!",
    "lobs": [
      {
        "id": 1,
        "name": "Hello, world!"
      }
    ]
  },
  "layerNumber": 1,
  "layerAmount": 1,
  "excessAmount": 1,
  "percentReinsurance": 1,
  "maolAmount": 1,
  "priority": 1,
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "exposureId": {
      "type": "number"
    },
    "exposureType": {
      "type": "string",
      "enum": [
        "POL",
        "LOC"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "None",
        "Facultative",
        "Treaty"
      ]
    },
    "facReinsurer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "treaty": {
      "type": "object",
      "properties": {
        "treatyId": {
          "type": "number"
        },
        "treatyNumber": {
          "type": "string"
        },
        "treatyName": {
          "type": "string"
        },
        "cedant": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "producer": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "treatyType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "currency": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "attachBasis": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "attachLevel": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "premium": {
          "type": "number"
        },
        "occurLimit": {
          "type": "number"
        },
        "attachPt": {
          "type": "number"
        },
        "riskLimit": {
          "type": "number"
        },
        "retentAmt": {
          "type": "number"
        },
        "pcntPlaced": {
          "type": "number"
        },
        "effectDate": {
          "type": "string"
        },
        "expireDate": {
          "type": "string"
        },
        "pcntRetent": {
          "type": "number"
        },
        "pcntRiShare": {
          "type": "number"
        },
        "pcntCovered": {
          "type": "number"
        },
        "priority": {
          "type": "number"
        },
        "numOfReinst": {
          "type": "number"
        },
        "reinstCharge": {
          "type": "number"
        },
        "maolAmount": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        },
        "userId1": {
          "type": "string"
        },
        "userId2": {
          "type": "string"
        },
        "lobs": {
          "type": "array"
        }
      },
      "required": [
        "cedant"
      ]
    },
    "layerNumber": {
      "type": "number"
    },
    "layerAmount": {
      "type": "number"
    },
    "excessAmount": {
      "type": "number"
    },
    "percentReinsurance": {
      "type": "number"
    },
    "maolAmount": {
      "type": "number"
    },
    "priority": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  201
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Policies Policycondition By Id

getPolicyCondition
GET/policies/{id}/policycondition/{conditionid}{?datasource}

Retrieves information for a condition specified by its ID for a policy specified by its ID.

Example URI

GET /api/v1/policies/id/policycondition/conditionid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

conditionid
number (required) 

ID number of the Policy Condition.

datasource
string (required) 

Name of the data source.

Response  200
HideShow

OK. Information for a condition specified by its ID for a policy specified by its ID is successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "isPredefined": true,
  "limit": 1,
  "deductible": 1,
  "deductibleType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "conditionType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "parentCondition": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "policyNumber": "Hello, world!",
  "policyConditionCriterias": [
    {
      "id": 1,
      "logic": "Hello, world!",
      "openPar": "Hello, world!",
      "field": "Hello, world!",
      "operator": "Hello, world!",
      "value": "Hello, world!",
      "closePar": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "isPredefined": {
      "type": "boolean"
    },
    "limit": {
      "type": "number"
    },
    "deductible": {
      "type": "number"
    },
    "deductibleType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "conditionType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "parentCondition": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "policyNumber": {
      "type": "string"
    },
    "policyConditionCriterias": {
      "type": "array"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updatePolicyCondition
PUT/policies/{id}/policycondition/{conditionid}{?datasource}

Updates a condition specified by its ID for a policy specified by its ID.

Example URI

PUT /api/v1/policies/id/policycondition/conditionid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

conditionid
number (required) 

ID number of the Policy Condition.

datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "isPredefined": true,
  "limit": 1,
  "deductible": 1,
  "deductibleType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "conditionType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "parentCondition": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "policyNumber": "Hello, world!",
  "policyConditionCriterias": [
    {
      "id": 1,
      "logic": "Hello, world!",
      "openPar": "Hello, world!",
      "field": "Hello, world!",
      "operator": "Hello, world!",
      "value": "Hello, world!",
      "closePar": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "isPredefined": {
      "type": "boolean"
    },
    "limit": {
      "type": "number"
    },
    "deductible": {
      "type": "number"
    },
    "deductibleType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "conditionType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "parentCondition": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "policyNumber": {
      "type": "string"
    },
    "policyConditionCriterias": {
      "type": "array"
    }
  }
}
Response  204
Response  404
HideShow

Not found. The resource referenced does not exist.

Headers
Content-Type: application/json
Body
{
  "links": [
    {
      "rel": "Hello, world!",
      "href": "Hello, world!",
      "method": "Hello, world!"
    }
  ],
  "meta": {
    "createdBy": "Hello, world!",
    "createdAt": "Hello, world!",
    "updatedBy": "Hello, world!",
    "updatedAt": "Hello, world!",
    "count": 1
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "links": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        },
        "updatedBy": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        },
        "count": {
          "type": "number"
        }
      }
    }
  },
  "required": [
    "links",
    "meta"
  ]
}

deletePolicyCondition
DELETE/policies/{id}/policycondition/{conditionid}{?datasource}

Deletes a policy condition

Example URI

DELETE /api/v1/policies/id/policycondition/conditionid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

conditionid
number (required) 

ID number of the Policy Condition.

datasource
string (required) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Policies Policycondition Locationconditions

getLocationConditions
GET/policies/{id}/policycondition/{conditionid}/locationconditions{?datasource}

Retrieves location conditions for a specified condition associated with a specified policy.

Example URI

GET /api/v1/policies/id/policycondition/conditionid/locationconditions?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

conditionid
number (required) 

ID number of the Policy Condition.

datasource
string (required) 

Name of the data source.

Response  200
HideShow

OK. Location conditions for a specified policy condition are successfully retrieved.

Headers
Content-Type: application/json
Body
[
  {
    "locationId": 1,
    "conditionId": 1,
    "isIncluded": "NotIncluded"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Policies Policycondition By Id

createPolicyCondition
POST/policies/{id}/policycondition{?datasource}

Creates a condition for a policy specified by its ID.

Example URI

POST /api/v1/policies/id/policycondition?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "isPredefined": true,
  "limit": 1,
  "deductible": 1,
  "deductibleType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "conditionType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "parentCondition": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "policyNumber": "Hello, world!",
  "policyConditionCriterias": [
    {
      "id": 1,
      "logic": "Hello, world!",
      "openPar": "Hello, world!",
      "field": "Hello, world!",
      "operator": "Hello, world!",
      "value": "Hello, world!",
      "closePar": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "isPredefined": {
      "type": "boolean"
    },
    "limit": {
      "type": "number"
    },
    "deductible": {
      "type": "number"
    },
    "deductibleType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "conditionType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "parentCondition": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "policyNumber": {
      "type": "string"
    },
    "policyConditionCriterias": {
      "type": "array"
    }
  }
}
Response  201
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Policies Policycondition Backfill By Id

backFillPolicyCondition
POST/policies/{id}/policycondition/{conditionid}/backfill{?datasource}

Back fill policy condition

Example URI

POST /api/v1/policies/id/policycondition/conditionid/backfill?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

conditionid
number (required) 

ID number of the Policy Condition.

datasource
string (required) 

Name of the data source.

Response  202

Policies Policycondition Criteria Criteriaid

getPolicyConditionCriteria
GET/policies/{id}/policycondition/{conditionid}/criteria/{criteriaid}{?datasource}

Retrieves information for a policy condition criteria specified by its ID for a condition specified by its ID associated with a policy specified by its ID.

Example URI

GET /api/v1/policies/id/policycondition/conditionid/criteria/criteriaid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

conditionid
number (required) 

ID number of the Policy Condition.

criteriaid
number (required) 

ID number of the Policy Condition Criteria.

datasource
string (required) 

Name of the data source.

Response  200
HideShow

OK. Information for the specified policy condition criteria is successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "logic": "Hello, world!",
  "openPar": "Hello, world!",
  "field": "Hello, world!",
  "operator": "Hello, world!",
  "value": "Hello, world!",
  "closePar": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "logic": {
      "type": "string"
    },
    "openPar": {
      "type": "string"
    },
    "field": {
      "type": "string"
    },
    "operator": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "closePar": {
      "type": "string"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updatePolicyConditionCriteria
PUT/policies/{id}/policycondition/{conditionid}/criteria/{criteriaid}{?datasource}

Updates policy condition criteria

Example URI

PUT /api/v1/policies/id/policycondition/conditionid/criteria/criteriaid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

conditionid
number (required) 

ID number of the Policy Condition.

criteriaid
number (required) 

ID number of the Policy Condition Criteria.

datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "logic": "Hello, world!",
  "openPar": "Hello, world!",
  "field": "Hello, world!",
  "operator": "Hello, world!",
  "value": "Hello, world!",
  "closePar": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "logic": {
      "type": "string"
    },
    "openPar": {
      "type": "string"
    },
    "field": {
      "type": "string"
    },
    "operator": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "closePar": {
      "type": "string"
    }
  }
}
Response  204
Response  404
HideShow

Not found. The resource referenced does not exist.

Headers
Content-Type: application/json
Body
{
  "links": [
    {
      "rel": "Hello, world!",
      "href": "Hello, world!",
      "method": "Hello, world!"
    }
  ],
  "meta": {
    "createdBy": "Hello, world!",
    "createdAt": "Hello, world!",
    "updatedBy": "Hello, world!",
    "updatedAt": "Hello, world!",
    "count": 1
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "links": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        },
        "updatedBy": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        },
        "count": {
          "type": "number"
        }
      }
    }
  },
  "required": [
    "links",
    "meta"
  ]
}

deletePolicyConditionCriteria
DELETE/policies/{id}/policycondition/{conditionid}/criteria/{criteriaid}{?datasource}

Deletes a policy condition criteria

Example URI

DELETE /api/v1/policies/id/policycondition/conditionid/criteria/criteriaid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

conditionid
number (required) 

ID number of the Policy Condition.

criteriaid
number (required) 

ID number of the Policy Condition Criteria.

datasource
string (required) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Policies Policycondition Criteria By Id

createPolicyConditionCriteria
POST/policies/{id}/policycondition/{conditionid}/criteria{?datasource}

Creates a policy condition criteria

Example URI

POST /api/v1/policies/id/policycondition/conditionid/criteria?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

conditionid
number (required) 

ID number of the Policy Condition.

datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "logic": "Hello, world!",
  "openPar": "Hello, world!",
  "field": "Hello, world!",
  "operator": "Hello, world!",
  "value": "Hello, world!",
  "closePar": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "logic": {
      "type": "string"
    },
    "openPar": {
      "type": "string"
    },
    "field": {
      "type": "string"
    },
    "operator": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "closePar": {
      "type": "string"
    }
  }
}
Response  201
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Policies Surplustreaties By Id

getSurplusTreaties
GET/policies/{id}/surplustreaties{?datasource}

Retrieves list of surplus treaties for a policy specified by its ID.

Example URI

GET /api/v1/policies/id/surplustreaties?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the policy.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK. List of surplus treaties for a specified policy is successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "treatyId": 1,
  "treatyNumber": "Hello, world!",
  "treatyName": "Hello, world!",
  "cedant": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "producer": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "treatyType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "currency": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "attachBasis": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "attachLevel": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "premium": 1,
  "occurLimit": 1,
  "attachPt": 1,
  "riskLimit": 1,
  "retentAmt": 1,
  "pcntPlaced": 1,
  "effectDate": "Hello, world!",
  "expireDate": "Hello, world!",
  "pcntRetent": 1,
  "pcntRiShare": 1,
  "pcntCovered": 1,
  "priority": 1,
  "numOfReinst": 1,
  "reinstCharge": 1,
  "maolAmount": 1,
  "isValid": true,
  "userId1": "Hello, world!",
  "userId2": "Hello, world!",
  "lobs": [
    {
      "id": 1,
      "name": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "treatyId": {
      "type": "number"
    },
    "treatyNumber": {
      "type": "string"
    },
    "treatyName": {
      "type": "string"
    },
    "cedant": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "producer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "treatyType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "currency": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "attachBasis": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "attachLevel": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "premium": {
      "type": "number"
    },
    "occurLimit": {
      "type": "number"
    },
    "attachPt": {
      "type": "number"
    },
    "riskLimit": {
      "type": "number"
    },
    "retentAmt": {
      "type": "number"
    },
    "pcntPlaced": {
      "type": "number"
    },
    "effectDate": {
      "type": "string"
    },
    "expireDate": {
      "type": "string"
    },
    "pcntRetent": {
      "type": "number"
    },
    "pcntRiShare": {
      "type": "number"
    },
    "pcntCovered": {
      "type": "number"
    },
    "priority": {
      "type": "number"
    },
    "numOfReinst": {
      "type": "number"
    },
    "reinstCharge": {
      "type": "number"
    },
    "maolAmount": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    },
    "userId1": {
      "type": "string"
    },
    "userId2": {
      "type": "string"
    },
    "lobs": {
      "type": "array"
    }
  },
  "required": [
    "cedant"
  ]
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Policies

searchPolicies
GET/policies{?datasource,q,sort,limit,offset}

Retrieves list of policies filtered by the specified parameters.

Example URI

GET /api/v1/policies?datasource=&q=&sort=&limit=&offset=
URI Parameters
HideShow
datasource
string (required) 

Name of the data source.

q
string (optional) 

Filters applied to the query results.

sort
string (optional) 

Specify comma-delimited field names followed by ‘ASC’ (to display the results in alphabetical or numerical ascending order) or ‘DESC’ (to display the results in descending order.)

limit
number (optional) 

Maximum number of retrieved records to display on the page.

offset
number (optional) 

Number of the page displaying the returned records, starting at ‘0’.

Response  200
HideShow

OK. List of policies is successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "matchCount": 1,
  "policies": [
    {
      "coverages": [
        {
          "id": 1,
          "peril": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "lossType": "Building",
          "premium": 1,
          "limit": 1,
          "deductible": 1,
          "label": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "accumulation": 1,
          "isValid": true
        }
      ],
      "reinsuranceCessions": [
        {
          "id": 1,
          "name": "Hello, world!",
          "exposureId": 1,
          "exposureType": "POL",
          "type": "None",
          "facReinsurer": {
            "id": "Hello, world!",
            "name": "Hello, world!"
          },
          "treaty": {
            "treatyId": 1,
            "treatyNumber": "Hello, world!",
            "treatyName": "Hello, world!",
            "cedant": {
              "id": "Hello, world!",
              "name": "Hello, world!"
            },
            "producer": {
              "id": "Hello, world!",
              "name": "Hello, world!"
            },
            "treatyType": {
              "id": 1,
              "code": "Hello, world!",
              "name": "Hello, world!"
            },
            "currency": {
              "id": 1,
              "code": "Hello, world!",
              "name": "Hello, world!"
            },
            "attachBasis": {
              "id": 1,
              "code": "Hello, world!",
              "name": "Hello, world!"
            },
            "attachLevel": {
              "id": 1,
              "code": "Hello, world!",
              "name": "Hello, world!"
            },
            "premium": 1,
            "occurLimit": 1,
            "attachPt": 1,
            "riskLimit": 1,
            "retentAmt": 1,
            "pcntPlaced": 1,
            "effectDate": "Hello, world!",
            "expireDate": "Hello, world!",
            "pcntRetent": 1,
            "pcntRiShare": 1,
            "pcntCovered": 1,
            "priority": 1,
            "numOfReinst": 1,
            "reinstCharge": 1,
            "maolAmount": 1,
            "isValid": true,
            "userId1": "Hello, world!",
            "userId2": "Hello, world!",
            "lobs": [
              {
                "id": 1,
                "name": "Hello, world!"
              }
            ]
          },
          "layerNumber": 1,
          "layerAmount": 1,
          "excessAmount": 1,
          "percentReinsurance": 1,
          "maolAmount": 1,
          "priority": 1,
          "isValid": true
        }
      ],
      "policyConditions": [
        {
          "id": 1,
          "name": "Hello, world!",
          "isPredefined": true,
          "limit": 1,
          "deductible": 1,
          "deductibleType": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "conditionType": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "parentCondition": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "policyNumber": "Hello, world!",
          "policyConditionCriterias": [
            {
              "id": 1,
              "logic": "Hello, world!",
              "openPar": "Hello, world!",
              "field": "Hello, world!",
              "operator": "Hello, world!",
              "value": "Hello, world!",
              "closePar": "Hello, world!"
            }
          ]
        }
      ],
      "id": 1,
      "number": "Hello, world!",
      "accountId": 1,
      "lob": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "peril": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "status": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "inceptionDate": "Hello, world!",
      "expirationDate": "Hello, world!",
      "currency": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "partOf": 1,
      "attachmentPoint": 1,
      "minDeductible": 1,
      "maxDeductible": 1,
      "blanketLimit": 1,
      "blanketDeductible": 1,
      "blanketPremium": 1,
      "biLifeLine": 1,
      "deductType": 1,
      "structure": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "coverageBase": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "limitGU": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "userText1": "Hello, world!",
      "userText2": "Hello, world!",
      "userText3": "Hello, world!",
      "userText4": "Hello, world!",
      "isValid": true,
      "CustomData": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "matchCount": {
      "type": "number"
    },
    "policies": {
      "type": "array"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Policies

createPolicy
POST/policies{?datasource}

Creates a policy.

Example URI

POST /api/v1/policies?datasource=
URI Parameters
HideShow
datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "coverages": [
    {
      "id": 1,
      "peril": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "lossType": "Building",
      "premium": 1,
      "limit": 1,
      "deductible": 1,
      "label": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "accumulation": 1,
      "isValid": true
    }
  ],
  "reinsuranceCessions": [
    {
      "id": 1,
      "name": "Hello, world!",
      "exposureId": 1,
      "exposureType": "POL",
      "type": "None",
      "facReinsurer": {
        "id": "Hello, world!",
        "name": "Hello, world!"
      },
      "treaty": {
        "treatyId": 1,
        "treatyNumber": "Hello, world!",
        "treatyName": "Hello, world!",
        "cedant": {
          "id": "Hello, world!",
          "name": "Hello, world!"
        },
        "producer": {
          "id": "Hello, world!",
          "name": "Hello, world!"
        },
        "treatyType": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "currency": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "attachBasis": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "attachLevel": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "premium": 1,
        "occurLimit": 1,
        "attachPt": 1,
        "riskLimit": 1,
        "retentAmt": 1,
        "pcntPlaced": 1,
        "effectDate": "Hello, world!",
        "expireDate": "Hello, world!",
        "pcntRetent": 1,
        "pcntRiShare": 1,
        "pcntCovered": 1,
        "priority": 1,
        "numOfReinst": 1,
        "reinstCharge": 1,
        "maolAmount": 1,
        "isValid": true,
        "userId1": "Hello, world!",
        "userId2": "Hello, world!",
        "lobs": [
          {
            "id": 1,
            "name": "Hello, world!"
          }
        ]
      },
      "layerNumber": 1,
      "layerAmount": 1,
      "excessAmount": 1,
      "percentReinsurance": 1,
      "maolAmount": 1,
      "priority": 1,
      "isValid": true
    }
  ],
  "policyConditions": [
    {
      "id": 1,
      "name": "Hello, world!",
      "isPredefined": true,
      "limit": 1,
      "deductible": 1,
      "deductibleType": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "conditionType": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "parentCondition": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "policyNumber": "Hello, world!",
      "policyConditionCriterias": [
        {
          "id": 1,
          "logic": "Hello, world!",
          "openPar": "Hello, world!",
          "field": "Hello, world!",
          "operator": "Hello, world!",
          "value": "Hello, world!",
          "closePar": "Hello, world!"
        }
      ]
    }
  ],
  "id": 1,
  "number": "Hello, world!",
  "accountId": 1,
  "lob": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "peril": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "status": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "inceptionDate": "Hello, world!",
  "expirationDate": "Hello, world!",
  "currency": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "partOf": 1,
  "attachmentPoint": 1,
  "minDeductible": 1,
  "maxDeductible": 1,
  "blanketLimit": 1,
  "blanketDeductible": 1,
  "blanketPremium": 1,
  "biLifeLine": 1,
  "deductType": 1,
  "structure": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "coverageBase": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "limitGU": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "userText1": "Hello, world!",
  "userText2": "Hello, world!",
  "userText3": "Hello, world!",
  "userText4": "Hello, world!",
  "isValid": true,
  "CustomData": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "coverages": {
      "type": "array"
    },
    "reinsuranceCessions": {
      "type": "array"
    },
    "policyConditions": {
      "type": "array"
    },
    "id": {
      "type": "number"
    },
    "number": {
      "type": "string"
    },
    "accountId": {
      "type": "number"
    },
    "lob": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "peril": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "status": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "inceptionDate": {
      "type": "string"
    },
    "expirationDate": {
      "type": "string"
    },
    "currency": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "partOf": {
      "type": "number"
    },
    "attachmentPoint": {
      "type": "number"
    },
    "minDeductible": {
      "type": "number"
    },
    "maxDeductible": {
      "type": "number"
    },
    "blanketLimit": {
      "type": "number"
    },
    "blanketDeductible": {
      "type": "number"
    },
    "blanketPremium": {
      "type": "number"
    },
    "biLifeLine": {
      "type": "number"
    },
    "deductType": {
      "type": "number"
    },
    "structure": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "coverageBase": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "limitGU": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "userText1": {
      "type": "string"
    },
    "userText2": {
      "type": "string"
    },
    "userText3": {
      "type": "string"
    },
    "userText4": {
      "type": "string"
    },
    "isValid": {
      "type": "boolean"
    },
    "CustomData": {
      "type": "string"
    }
  }
}
Response  201
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Portfolio

Exposurebatches

executeBatchOperation
POST/exposurebatches{?operation}

Batch operation a list of portfolios

Example URI

POST /api/v1/exposurebatches?operation=
URI Parameters
HideShow
operation
string (optional) 

operation of batch resource

Request
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "method": "Hello, world!",
    "path": "Hello, world!",
    "body": "Hello, world!"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  200
HideShow

Execute a batch of operations.

Headers
Content-Type: application/json
Body
[
  {
    "headers": {},
    "statusInfo": {
      "family": "INFORMATIONAL"
    },
    "metadata": {},
    "allowedMethods": [],
    "cookies": {},
    "links": [
      {
        "rels": []
      }
    ],
    "mediaType": {},
    "entityTag": {},
    "stringHeaders": {},
    "language": {
      "extensionKeys": [],
      "unicodeLocaleAttributes": [],
      "unicodeLocaleKeys": []
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  404
HideShow

Not found Request. resource not found.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Portfolios Copy By Id

copyPortfolio
POST/portfolios/{id}/copy{?datasource}

Copies existing portfolio.

Example URI

POST /api/v1/portfolios/id/copy?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the portfolio.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "deep": true,
  "newName": "Hello, world!",
  "newNumber": "Hello, world!",
  "newDescription": "Hello, world!",
  "isDeep": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "deep": {
      "type": "boolean"
    },
    "newName": {
      "type": "string"
    },
    "newNumber": {
      "type": "string"
    },
    "newDescription": {
      "type": "string"
    },
    "isDeep": {
      "type": "boolean"
    }
  },
  "required": [
    "newDescription"
  ]
}
Response  202

Portfolios Coordinates By Id

getCoordinatesByPortfolio
GET/portfolios/{id}/coordinates{?datasource}

Retrieves a list of location coordinates for a portfolio specified by its ID.

Example URI

GET /api/v1/portfolios/id/coordinates?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the portfolio.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK. Location coordinates retrieved.

Headers
Content-Type: application/json
Body
[
  {
    "locationId": 1,
    "locationNumber": "Hello, world!",
    "latitude": 1,
    "longitude": 1,
    "streetAddress": "Hello, world!",
    "geoResolutionCode": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Portfolios Filteredaccounts By Id

manageFilteredAccounts
PUT/portfolios/{id}/filteredaccounts{?datasource}

Manage filtered accounts in an already existing portfolio.

Example URI

PUT /api/v1/portfolios/id/filteredaccounts?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the portfolio.

datasource
string (optional) 

Name of the data source.

Request
Response  202

Portfolios Accounts By Id

searchPortfolioAccounts
GET/portfolios/{id}/accounts{?datasource,q,sort,limit,offset}

Retrieves list of accounts in portfolio, filtered by the specified parameters.

Example URI

GET /api/v1/portfolios/id/accounts?datasource=&q=&sort=&limit=&offset=
URI Parameters
HideShow
id
number (required) 

ID of the portfolio.

datasource
string (optional) 

Name of the data source.

q
string (optional) 

Filters applied to the query results.

sort
string (optional) 

Specify ‘ASC’ to display the results in alphabetical or numerical ascending order or ‘DESC’ to display the results in descending order.

limit
number (optional) 

Maximum number of retrieved records to display on the page.

offset
number (optional) 

Number of the page displaying the returned records, starting at ‘0’.

Response  200
HideShow

List of accounts retrieved.

Headers
Content-Type: application/json
Body
{
  "searchTotalMatch": 1,
  "searchItems": [
    {
      "accountId": 1,
      "accountNumber": "Hello, world!",
      "accountName": "Hello, world!",
      "cedantName": "Hello, world!",
      "producerName": "Hello, world!",
      "underwriterName": "Hello, world!",
      "branchName": "Hello, world!",
      "numLocations": 1,
      "userId1": "Hello, world!",
      "userId2": "Hello, world!",
      "userId3": "Hello, world!",
      "userId4": "Hello, world!",
      "userText1": "Hello, world!",
      "userText2": "Hello, world!",
      "geocodeVersion": "Hello, world!",
      "hazardVersion": "Hello, world!",
      "ownerName": "Hello, world!",
      "updatedBy": "Hello, world!",
      "stampDate": "Hello, world!",
      "jobStatus": "Hello, world!",
      "jobStartDate": "Hello, world!",
      "jobEndDate": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "searchTotalMatch": {
      "type": "number"
    },
    "searchItems": {
      "type": "array"
    }
  }
}

Portfolios Accounts By Id

managePortfolioAccounts
PUT/portfolios/{id}/accounts{?datasource}

Manage accounts in an already existing portfolio.

Example URI

PUT /api/v1/portfolios/id/accounts?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the portfolio.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "accountsToAdd": [
    1
  ],
  "accountsToRemove": [
    1
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "accountsToAdd": {
      "type": "array"
    },
    "accountsToRemove": {
      "type": "array"
    }
  }
}
Response  202

Portfolios Hazard By Id

hazardPortfolio
POST/portfolios/{id}/hazard{?datasource}

Geocode a portfolio

Example URI

POST /api/v1/portfolios/id/hazard?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the portfolio.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "empty": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "empty": {
      "type": "boolean"
    }
  }
}
Response  202

Portfolios Geocode By Id

geocodePortfolio
POST/portfolios/{id}/geocode{?datasource}

Geocode a portfolio

Example URI

POST /api/v1/portfolios/id/geocode?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the account.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "empty": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "empty": {
      "type": "boolean"
    }
  }
}
Response  201

Portfolios Analyses By Id

getAnalysesResults1
GET/portfolios/{id}/analyses{?datasource,sort,limit,offset}

Retrieves analyses for exposure specified by its ID.

Example URI

GET /api/v1/portfolios/id/analyses?datasource=&sort=&limit=&offset=
URI Parameters
HideShow
id
number (required) 

ID number of the portfolio.

datasource
string (optional) 

Name of the data source.

sort
string (optional) 

Specify ‘ASC’ to display the results in alphabetical or numerical ascending order or ‘DESC’ to display the results in descending order.

limit
number (optional) 

Maximum number of retrieved records to display on the page.

offset
number (optional) 

Number of the page displaying the returned records, starting at ‘0’.

Response  200
HideShow

OK. Analyses for exposure successfully retrieved.

Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "name": "Hello, world!",
    "runDate": "Hello, world!",
    "description": "Hello, world!",
    "currency": "Hello, world!",
    "type": 1,
    "exposureType": 1,
    "peril": "Hello, world!",
    "status": 1,
    "region": "Hello, world!",
    "engineVersion": "Hello, world!",
    "groupType": "Hello, world!",
    "cedant": "Hello, world!",
    "lob": "Hello, world!",
    "engineType": 1,
    "subperil": 1,
    "exposureId": 1,
    "dataSource": "Hello, world!"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Portfolios By Id

getPortfolio
GET/portfolios/{id}{?datasource}

Retrieves information on an portfolio specified by its ID.

Example URI

GET /api/v1/portfolios/id?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the portfolio.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK. Portfolio information retrieved.

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "number": "Hello, world!",
  "description": "Hello, world!",
  "createDate": "Hello, world!",
  "stampDate": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "number": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "createDate": {
      "type": "string"
    },
    "stampDate": {
      "type": "string"
    }
  },
  "required": [
    "description"
  ]
}

updatePortfolio
PUT/portfolios/{id}{?datasource}

Updates a portfolio specified by its ID with new information.

Example URI

PUT /api/v1/portfolios/id?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the portfolio.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "number": "Hello, world!",
  "description": "Hello, world!",
  "createDate": "Hello, world!",
  "stampDate": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "number": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "createDate": {
      "type": "string"
    },
    "stampDate": {
      "type": "string"
    }
  },
  "required": [
    "description"
  ]
}
Response  204

Portfolios By Id

deletePortfolio
DELETE/portfolios/{id}{?deleteType,datasource}

Deletes an portfolio specified by its ID.

Example URI

DELETE /api/v1/portfolios/id?deleteType=&datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the portfolio.

deleteType
string (required) 

Specify the delete type of portfolio ( ‘PORTFOLIO_INFO’ | ‘PORTFOLIO_ALL_ACCOUNTS’ | ‘PORTFOLIO_EXCEPT_ACCOUNTS’ ).

Choices: PORTFOLIO_INFO PORTFOLIO_ALL_ACCOUNTS PORTFOLIO_EXCEPT_ACCOUNTS

datasource
string (optional) 

Name of the data source.

Response  202

Portfolios

searchPortfolios
GET/portfolios{?datasource,q,sort,limit,offset}

Retrieves list of portfolios filtered by the specified parameters.

Example URI

GET /api/v1/portfolios?datasource=&q=&sort=&limit=&offset=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

q
string (optional) 

Filters applied to the query results.

sort
string (optional) 

Specify ‘ASC’ to display the results in alphabetical or numerical ascending order or ‘DESC’ to display the results in descending order.

limit
number (optional) 

Maximum number of retrieved records to display on the page.

offset
number (optional) 

Number of the page displaying the returned records, starting at ‘0’.

Response  200
HideShow

OK. List of portfolios retrieved.

Headers
Content-Type: application/json
Body
{
  "searchTotalMatch": 1,
  "searchItems": [
    {
      "id": 1,
      "name": "Hello, world!",
      "number": "Hello, world!",
      "description": "Hello, world!",
      "createDate": "Hello, world!",
      "stampDate": "Hello, world!",
      "geocodeVersion": "Hello, world!",
      "hazardVersion": "Hello, world!",
      "ownerName": "Hello, world!",
      "updatedBy": "Hello, world!",
      "jobStatus": "Hello, world!",
      "jobStartDate": "Hello, world!",
      "jobEndDate": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "searchTotalMatch": {
      "type": "number"
    },
    "searchItems": {
      "type": "array"
    }
  }
}

Portfolios

createPortfolio
POST/portfolios{?datasource}

Creates a new portfolio.

Example URI

POST /api/v1/portfolios?datasource=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "number": "Hello, world!",
  "description": "Hello, world!",
  "createDate": "Hello, world!",
  "stampDate": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "number": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "createDate": {
      "type": "string"
    },
    "stampDate": {
      "type": "string"
    }
  },
  "required": [
    "description"
  ]
}
Response  201

Portfolios Process By Id

processPortfolio
POST/portfolios/{id}/process

Places an portfolios into a queue, where it waits until the analysis occurs.

Example URI

POST /api/v1/portfolios/id/process
URI Parameters
HideShow
id
number (required) 

ID number of the portfolio.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "exposureType": "PORTFOLIO",
  "edm": "Hello, world!",
  "currency": {
    "code": "Hello, world!",
    "scheme": "Hello, world!",
    "asOfDate": "Hello, world!",
    "vintage": "Hello, world!"
  },
  "modelProfileId": 1,
  "eventRateSchemeId": 1,
  "outputSetting": {
    "metricRequests": [
      {
        "granularity": [
          "Hello, world!"
        ],
        "metricType": "Hello, world!",
        "perspective": "Hello, world!",
        "includeIntermediateSums": true
      }
    ]
  },
  "treaties": [
    1
  ],
  "outputProfile": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "exposureType": {
      "type": "string",
      "enum": [
        "PORTFOLIO",
        "ACCOUNT",
        "LOCATION",
        "POLICY",
        "TREATY"
      ]
    },
    "edm": {
      "type": "string"
    },
    "currency": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "scheme": {
          "type": "string"
        },
        "asOfDate": {
          "type": "string"
        },
        "vintage": {
          "type": "string"
        }
      }
    },
    "modelProfileId": {
      "type": "number"
    },
    "eventRateSchemeId": {
      "type": "number"
    },
    "outputSetting": {
      "type": "object",
      "properties": {
        "metricRequests": {
          "type": "array"
        }
      }
    },
    "treaties": {
      "type": "array"
    },
    "outputProfile": {
      "type": "string"
    }
  }
}
Response  200
HideShow

Portfolio processed.

Headers
Content-Type: application/json
Body
{
  "jobIds": [
    1
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "jobIds": {
      "type": "array"
    }
  }
}

Utility

Faclayers

getAllFacultativeLayers
GET/faclayers{?datasource}

Retrieves a list of all the facultative layers in the given data source.

Example URI

GET /api/v1/faclayers?datasource=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK. List of facultative layers is successfully retrieved.

Headers
Content-Type: application/json
Body
[
  {
    "id": "Hello, world!",
    "name": "Hello, world!"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Globaledit

edit1
POST/globaledit{?accountId,datasource,dryRun}

returns the number of items updated

Example URI

POST /api/v1/globaledit?accountId=&datasource=&dryRun=
URI Parameters
HideShow
accountId
number (required) 
datasource
string (required) 

Name of the data source.

dryRun
boolean (optional) Default: false 
Request
HideShow
Body
"Hello, world!"
Schema
{
  "type": "string",
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow

OK. The global edit was successfully performed.

Headers
Content-Type: application/json
Body
"Hello, world!"
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "string"
}

Utils Convert Criteriatoquery

convertPolicyCriteriaToQueryString
POST/utils/convert/criteriatoquery

Returns a query string that can be used to search for locations

Example URI

POST /api/v1/utils/convert/criteriatoquery
Request
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "logic": "Hello, world!",
    "openPar": "Hello, world!",
    "field": "Hello, world!",
    "operator": "Hello, world!",
    "value": "Hello, world!",
    "closePar": "Hello, world!"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  200
HideShow

OK. Policy condition criteria is successfully converted into a query string.

Headers
Content-Type: application/json
Body
"Hello, world!"
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "string"
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "links": [
    {
      "rel": "Hello, world!",
      "href": "Hello, world!",
      "method": "Hello, world!"
    }
  ],
  "meta": {
    "createdBy": "Hello, world!",
    "createdAt": "Hello, world!",
    "updatedBy": "Hello, world!",
    "updatedAt": "Hello, world!",
    "count": 1
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "links": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        },
        "updatedBy": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        },
        "count": {
          "type": "number"
        }
      }
    }
  },
  "required": [
    "links",
    "meta"
  ]
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Utils Convert Portfoliocriteriatoquery

convertPortfolioCriteriaToQueryString
POST/utils/convert/portfoliocriteriatoquery

Returns a query string that can be used to search for locations

Example URI

POST /api/v1/utils/convert/portfoliocriteriatoquery
Request
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "logic": "Hello, world!",
    "openPar": "Hello, world!",
    "field": "Hello, world!",
    "operator": "Hello, world!",
    "value": "Hello, world!",
    "closePar": "Hello, world!"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  200
HideShow

OK. Policy condition criteria is successfully converted into a query string.

Headers
Content-Type: application/json
Body
"Hello, world!"
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "string"
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Line of Business

Lobs

getLineOfBusinesss
GET/lobs{?datasource,q,sort,limit,offset}

Retrieves a list of the lineOfBusinesss in a specified data source.

Example URI

GET /api/v1/lobs?datasource=&q=&sort=&limit=&offset=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

q
string (optional) 

Filters applied to the query results.

sort
string (optional) 

Specify comma-delimited field names followed by ‘ASC’ (to display the results in alphabetical or numerical ascending order) or ‘DESC’ (to display the results in descending order.)

limit
number (optional) 

Maximum number of retrieved records to display on the page.

offset
number (optional) 

Number of the page displaying the returned records, starting at ‘0’.

Response  200
HideShow

OK. Get List of lineOfBusinesss in the data source is successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "searchTotalMatch": 1,
  "searchItems": [
    {
      "id": 1,
      "name": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "searchTotalMatch": {
      "type": "number"
    },
    "searchItems": {
      "type": "array"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Lobs

createLineOfBusiness
POST/lobs{?datasource}

Creates new LineOfBusiness in a specified data source.

Example URI

POST /api/v1/lobs?datasource=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  201
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Lobs By Id

getLineOfBusinessById
GET/lobs/{id}{?datasource}

Retrieves a LineOfBusiness by id in a specified data source.

Example URI

GET /api/v1/lobs/id?datasource=
URI Parameters
HideShow
id
number (required) 

ID of the LineOfBusiness.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK. LineOfBusiness by Id in the data source is successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  404
HideShow

Not found Request. resource not found.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updateLineOfBusiness
PUT/lobs/{id}{?datasource}

Updates existing LineOfBusiness in a specified data source.

Example URI

PUT /api/v1/lobs/id?datasource=
URI Parameters
HideShow
id
number (required) 

ID of the LineOfBusiness.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  404
HideShow

Not found Request. resource not found.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

deleteLineOfBusiness
DELETE/lobs/{id}{?datasource}

Deletes existing LineOfBusiness in a specified data source.

Example URI

DELETE /api/v1/lobs/id?datasource=
URI Parameters
HideShow
id
number (required) 

ID of the LineOfBusiness.

datasource
string (optional) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  404
HideShow

Not found Request. resource not found.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Location

Locations Locationwcdetail By Id

getLocationWcDetail
GET/locations/{id}/locationwcdetail/{locationwcdetailid}{?datasource}

Gets a location WC detail

Example URI

GET /api/v1/locations/id/locationwcdetail/locationwcdetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationwcdetailid
number (required) 

ID number of the location worker compensation record.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "totalPayroll": 1,
  "totalNumEmployees": 1,
  "numEmployeesShift1": 1,
  "numEmployeesShift2": 1,
  "numEmployeesShift3": 1,
  "numEmployeesShift4": 1,
  "calcNumEmployees": 1,
  "emergencyProtection": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "hazardousMaterials": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wageRelativity": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "riskManagement": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "employeeDensity": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "undMngtAdjustment": 1,
  "groupNum": "Hello, world!",
  "groupName": "Hello, world!",
  "occupancyTypeScheme": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "occupancyType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "maxEmployees": 1,
  "shiftType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "isValid": true,
  "uslh": true,
  "excessComp": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "totalPayroll": {
      "type": "number"
    },
    "totalNumEmployees": {
      "type": "number"
    },
    "numEmployeesShift1": {
      "type": "number"
    },
    "numEmployeesShift2": {
      "type": "number"
    },
    "numEmployeesShift3": {
      "type": "number"
    },
    "numEmployeesShift4": {
      "type": "number"
    },
    "calcNumEmployees": {
      "type": "number"
    },
    "emergencyProtection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "hazardousMaterials": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wageRelativity": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "riskManagement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "employeeDensity": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "undMngtAdjustment": {
      "type": "number"
    },
    "groupNum": {
      "type": "string"
    },
    "groupName": {
      "type": "string"
    },
    "occupancyTypeScheme": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "occupancyType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "maxEmployees": {
      "type": "number"
    },
    "shiftType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "isValid": {
      "type": "boolean"
    },
    "uslh": {
      "type": "boolean"
    },
    "excessComp": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updateLocationWcDetail
PUT/locations/{id}/locationwcdetail/{locationwcdetailid}{?datasource}

Updates a location wc detail

Example URI

PUT /api/v1/locations/id/locationwcdetail/locationwcdetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationwcdetailid
number (required) 

ID number of the location worker compensation record.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "totalPayroll": 1,
  "totalNumEmployees": 1,
  "numEmployeesShift1": 1,
  "numEmployeesShift2": 1,
  "numEmployeesShift3": 1,
  "numEmployeesShift4": 1,
  "calcNumEmployees": 1,
  "emergencyProtection": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "hazardousMaterials": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wageRelativity": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "riskManagement": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "employeeDensity": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "undMngtAdjustment": 1,
  "groupNum": "Hello, world!",
  "groupName": "Hello, world!",
  "occupancyTypeScheme": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "occupancyType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "maxEmployees": 1,
  "shiftType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "isValid": true,
  "uslh": true,
  "excessComp": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "totalPayroll": {
      "type": "number"
    },
    "totalNumEmployees": {
      "type": "number"
    },
    "numEmployeesShift1": {
      "type": "number"
    },
    "numEmployeesShift2": {
      "type": "number"
    },
    "numEmployeesShift3": {
      "type": "number"
    },
    "numEmployeesShift4": {
      "type": "number"
    },
    "calcNumEmployees": {
      "type": "number"
    },
    "emergencyProtection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "hazardousMaterials": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wageRelativity": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "riskManagement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "employeeDensity": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "undMngtAdjustment": {
      "type": "number"
    },
    "groupNum": {
      "type": "string"
    },
    "groupName": {
      "type": "string"
    },
    "occupancyTypeScheme": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "occupancyType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "maxEmployees": {
      "type": "number"
    },
    "shiftType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "isValid": {
      "type": "boolean"
    },
    "uslh": {
      "type": "boolean"
    },
    "excessComp": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}
Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

deleteLocationWcDetail
DELETE/locations/{id}/locationwcdetail/{locationwcdetailid}{?datasource}

Deletes a location wc detail

Example URI

DELETE /api/v1/locations/id/locationwcdetail/locationwcdetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationwcdetailid
number (required) 

ID number of the location worker compensation record.

datasource
string (optional) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Locationeqdetail By Id

createLocationEqDetail
POST/locations/{id}/locationeqdetail{?datasource}

Create a new eq detail

Example URI

POST /api/v1/locations/id/locationeqdetail?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "yearUpgrade": "Hello, world!",
  "startDate": "Hello, world!",
  "completionDate": "Hello, world!",
  "yearSprinkler": "Hello, world!",
  "percentComplete": 1,
  "atcClass": "Hello, world!",
  "isoClass": "Hello, world!",
  "fireClass": "Hello, world!",
  "rmsClass": "Hello, world!",
  "userClass": "Hello, world!",
  "atcOccupancy": "Hello, world!",
  "isoOccupancy": "Hello, world!",
  "sicOccupancy": "Hello, world!",
  "ibcOccupancy": "Hello, world!",
  "userOccupancy": "Hello, world!",
  "secondarySupply": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqslSusceptibility": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "sprinklerType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "baseIsolation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "bldgExterior": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladding": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "constructQuality": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ductility": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "duress": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "enggFoundation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "frameBolt": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "hazardExposed": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "internalMasonaryPart": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "longSpan": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecEquip": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ornamentation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "overhangProfile": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "preFabrication": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "pounding": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "redundancy": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "shapeConfigure": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "shortColumn": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "sidingType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "storyProfile": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "structureUpgrade": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tank": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tiltupRetrofit": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "torsion": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "urmRetrofit": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wallsBrace": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tsDebris": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tsScour": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tsSafeDist": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tsProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "urmChimney": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "builtOnSlope": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "alquistPreoloZone": 1,
  "soil": 1,
  "landslide": 1,
  "liquefaction": 1,
  "biZone": 1,
  "landslideMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "liquefactionMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "soilMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "fireLossMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "landslideCov": 1,
  "liquefactionCov": 1,
  "soilCov": 1,
  "fireLossCov": 1,
  "soilPeriod": 1,
  "soilThickness": 1,
  "fire1": 1,
  "fire2": 1,
  "fire3": 1,
  "fire4": 1,
  "fire5": 1,
  "fire6": 1,
  "fire7": 1,
  "fire8": 1,
  "mmi100": 1,
  "mmi200": 1,
  "mmi250": 1,
  "mmi475": 1,
  "avgSlope": 1,
  "distFault1": 1,
  "apMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mmiMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "distSinkhole": 1,
  "distMine": 1,
  "sinkholeZone": 1,
  "soilVs": 1,
  "soilVsMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "basinLocId": 1,
  "di": 1,
  "critd": 1,
  "n160CS": 1,
  "t15": 1,
  "wff": 1,
  "distriv": 1,
  "gwd": 1,
  "dc": 1,
  "liqcv": 1,
  "hdLiqMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "phi": 1,
  "rough": 1,
  "ndvi": 1,
  "cohes": 1,
  "landcv": 1,
  "hdLandMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqSlope": 1,
  "elev": 1,
  "cti": 1,
  "precip": 1,
  "topo": 1,
  "hdSecMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "isValid": true,
  "eqslInsurance": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "completionDate": {
      "type": "string"
    },
    "yearSprinkler": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "atcClass": {
      "type": "string"
    },
    "isoClass": {
      "type": "string"
    },
    "fireClass": {
      "type": "string"
    },
    "rmsClass": {
      "type": "string"
    },
    "userClass": {
      "type": "string"
    },
    "atcOccupancy": {
      "type": "string"
    },
    "isoOccupancy": {
      "type": "string"
    },
    "sicOccupancy": {
      "type": "string"
    },
    "ibcOccupancy": {
      "type": "string"
    },
    "userOccupancy": {
      "type": "string"
    },
    "secondarySupply": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqslSusceptibility": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "sprinklerType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "baseIsolation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "bldgExterior": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladding": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "constructQuality": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ductility": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "duress": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "enggFoundation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "frameBolt": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "hazardExposed": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "internalMasonaryPart": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "longSpan": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecEquip": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ornamentation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "overhangProfile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "preFabrication": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "pounding": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "redundancy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "shapeConfigure": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "shortColumn": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "sidingType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "storyProfile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "structureUpgrade": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tank": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tiltupRetrofit": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "torsion": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "urmRetrofit": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wallsBrace": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tsDebris": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tsScour": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tsSafeDist": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tsProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "urmChimney": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "builtOnSlope": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "alquistPreoloZone": {
      "type": "number"
    },
    "soil": {
      "type": "number"
    },
    "landslide": {
      "type": "number"
    },
    "liquefaction": {
      "type": "number"
    },
    "biZone": {
      "type": "number"
    },
    "landslideMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "liquefactionMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "soilMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "fireLossMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "landslideCov": {
      "type": "number"
    },
    "liquefactionCov": {
      "type": "number"
    },
    "soilCov": {
      "type": "number"
    },
    "fireLossCov": {
      "type": "number"
    },
    "soilPeriod": {
      "type": "number"
    },
    "soilThickness": {
      "type": "number"
    },
    "fire1": {
      "type": "number"
    },
    "fire2": {
      "type": "number"
    },
    "fire3": {
      "type": "number"
    },
    "fire4": {
      "type": "number"
    },
    "fire5": {
      "type": "number"
    },
    "fire6": {
      "type": "number"
    },
    "fire7": {
      "type": "number"
    },
    "fire8": {
      "type": "number"
    },
    "mmi100": {
      "type": "number"
    },
    "mmi200": {
      "type": "number"
    },
    "mmi250": {
      "type": "number"
    },
    "mmi475": {
      "type": "number"
    },
    "avgSlope": {
      "type": "number"
    },
    "distFault1": {
      "type": "number"
    },
    "apMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mmiMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "distSinkhole": {
      "type": "number"
    },
    "distMine": {
      "type": "number"
    },
    "sinkholeZone": {
      "type": "number"
    },
    "soilVs": {
      "type": "number"
    },
    "soilVsMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "basinLocId": {
      "type": "number"
    },
    "di": {
      "type": "number"
    },
    "critd": {
      "type": "number"
    },
    "n160CS": {
      "type": "number"
    },
    "t15": {
      "type": "number"
    },
    "wff": {
      "type": "number"
    },
    "distriv": {
      "type": "number"
    },
    "gwd": {
      "type": "number"
    },
    "dc": {
      "type": "number"
    },
    "liqcv": {
      "type": "number"
    },
    "hdLiqMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "phi": {
      "type": "number"
    },
    "rough": {
      "type": "number"
    },
    "ndvi": {
      "type": "number"
    },
    "cohes": {
      "type": "number"
    },
    "landcv": {
      "type": "number"
    },
    "hdLandMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqSlope": {
      "type": "number"
    },
    "elev": {
      "type": "number"
    },
    "cti": {
      "type": "number"
    },
    "precip": {
      "type": "number"
    },
    "topo": {
      "type": "number"
    },
    "hdSecMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "isValid": {
      "type": "boolean"
    },
    "eqslInsurance": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}
Response  201

Locations Locationeqdetail By Id

getLocationEqDetail
GET/locations/{id}/locationeqdetail/{locationeqdetailid}{?datasource}

Gets a location EQ detail

Example URI

GET /api/v1/locations/id/locationeqdetail/locationeqdetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationeqdetailid
number (required) 

ID number of the location earthquake record.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "yearUpgrade": "Hello, world!",
  "startDate": "Hello, world!",
  "completionDate": "Hello, world!",
  "yearSprinkler": "Hello, world!",
  "percentComplete": 1,
  "atcClass": "Hello, world!",
  "isoClass": "Hello, world!",
  "fireClass": "Hello, world!",
  "rmsClass": "Hello, world!",
  "userClass": "Hello, world!",
  "atcOccupancy": "Hello, world!",
  "isoOccupancy": "Hello, world!",
  "sicOccupancy": "Hello, world!",
  "ibcOccupancy": "Hello, world!",
  "userOccupancy": "Hello, world!",
  "secondarySupply": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqslSusceptibility": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "sprinklerType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "baseIsolation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "bldgExterior": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladding": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "constructQuality": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ductility": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "duress": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "enggFoundation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "frameBolt": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "hazardExposed": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "internalMasonaryPart": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "longSpan": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecEquip": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ornamentation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "overhangProfile": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "preFabrication": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "pounding": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "redundancy": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "shapeConfigure": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "shortColumn": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "sidingType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "storyProfile": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "structureUpgrade": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tank": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tiltupRetrofit": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "torsion": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "urmRetrofit": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wallsBrace": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tsDebris": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tsScour": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tsSafeDist": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tsProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "urmChimney": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "builtOnSlope": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "alquistPreoloZone": 1,
  "soil": 1,
  "landslide": 1,
  "liquefaction": 1,
  "biZone": 1,
  "landslideMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "liquefactionMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "soilMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "fireLossMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "landslideCov": 1,
  "liquefactionCov": 1,
  "soilCov": 1,
  "fireLossCov": 1,
  "soilPeriod": 1,
  "soilThickness": 1,
  "fire1": 1,
  "fire2": 1,
  "fire3": 1,
  "fire4": 1,
  "fire5": 1,
  "fire6": 1,
  "fire7": 1,
  "fire8": 1,
  "mmi100": 1,
  "mmi200": 1,
  "mmi250": 1,
  "mmi475": 1,
  "avgSlope": 1,
  "distFault1": 1,
  "apMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mmiMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "distSinkhole": 1,
  "distMine": 1,
  "sinkholeZone": 1,
  "soilVs": 1,
  "soilVsMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "basinLocId": 1,
  "di": 1,
  "critd": 1,
  "n160CS": 1,
  "t15": 1,
  "wff": 1,
  "distriv": 1,
  "gwd": 1,
  "dc": 1,
  "liqcv": 1,
  "hdLiqMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "phi": 1,
  "rough": 1,
  "ndvi": 1,
  "cohes": 1,
  "landcv": 1,
  "hdLandMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqSlope": 1,
  "elev": 1,
  "cti": 1,
  "precip": 1,
  "topo": 1,
  "hdSecMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "isValid": true,
  "eqslInsurance": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "completionDate": {
      "type": "string"
    },
    "yearSprinkler": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "atcClass": {
      "type": "string"
    },
    "isoClass": {
      "type": "string"
    },
    "fireClass": {
      "type": "string"
    },
    "rmsClass": {
      "type": "string"
    },
    "userClass": {
      "type": "string"
    },
    "atcOccupancy": {
      "type": "string"
    },
    "isoOccupancy": {
      "type": "string"
    },
    "sicOccupancy": {
      "type": "string"
    },
    "ibcOccupancy": {
      "type": "string"
    },
    "userOccupancy": {
      "type": "string"
    },
    "secondarySupply": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqslSusceptibility": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "sprinklerType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "baseIsolation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "bldgExterior": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladding": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "constructQuality": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ductility": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "duress": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "enggFoundation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "frameBolt": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "hazardExposed": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "internalMasonaryPart": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "longSpan": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecEquip": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ornamentation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "overhangProfile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "preFabrication": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "pounding": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "redundancy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "shapeConfigure": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "shortColumn": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "sidingType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "storyProfile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "structureUpgrade": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tank": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tiltupRetrofit": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "torsion": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "urmRetrofit": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wallsBrace": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tsDebris": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tsScour": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tsSafeDist": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tsProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "urmChimney": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "builtOnSlope": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "alquistPreoloZone": {
      "type": "number"
    },
    "soil": {
      "type": "number"
    },
    "landslide": {
      "type": "number"
    },
    "liquefaction": {
      "type": "number"
    },
    "biZone": {
      "type": "number"
    },
    "landslideMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "liquefactionMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "soilMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "fireLossMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "landslideCov": {
      "type": "number"
    },
    "liquefactionCov": {
      "type": "number"
    },
    "soilCov": {
      "type": "number"
    },
    "fireLossCov": {
      "type": "number"
    },
    "soilPeriod": {
      "type": "number"
    },
    "soilThickness": {
      "type": "number"
    },
    "fire1": {
      "type": "number"
    },
    "fire2": {
      "type": "number"
    },
    "fire3": {
      "type": "number"
    },
    "fire4": {
      "type": "number"
    },
    "fire5": {
      "type": "number"
    },
    "fire6": {
      "type": "number"
    },
    "fire7": {
      "type": "number"
    },
    "fire8": {
      "type": "number"
    },
    "mmi100": {
      "type": "number"
    },
    "mmi200": {
      "type": "number"
    },
    "mmi250": {
      "type": "number"
    },
    "mmi475": {
      "type": "number"
    },
    "avgSlope": {
      "type": "number"
    },
    "distFault1": {
      "type": "number"
    },
    "apMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mmiMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "distSinkhole": {
      "type": "number"
    },
    "distMine": {
      "type": "number"
    },
    "sinkholeZone": {
      "type": "number"
    },
    "soilVs": {
      "type": "number"
    },
    "soilVsMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "basinLocId": {
      "type": "number"
    },
    "di": {
      "type": "number"
    },
    "critd": {
      "type": "number"
    },
    "n160CS": {
      "type": "number"
    },
    "t15": {
      "type": "number"
    },
    "wff": {
      "type": "number"
    },
    "distriv": {
      "type": "number"
    },
    "gwd": {
      "type": "number"
    },
    "dc": {
      "type": "number"
    },
    "liqcv": {
      "type": "number"
    },
    "hdLiqMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "phi": {
      "type": "number"
    },
    "rough": {
      "type": "number"
    },
    "ndvi": {
      "type": "number"
    },
    "cohes": {
      "type": "number"
    },
    "landcv": {
      "type": "number"
    },
    "hdLandMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqSlope": {
      "type": "number"
    },
    "elev": {
      "type": "number"
    },
    "cti": {
      "type": "number"
    },
    "precip": {
      "type": "number"
    },
    "topo": {
      "type": "number"
    },
    "hdSecMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "isValid": {
      "type": "boolean"
    },
    "eqslInsurance": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updateLocationEqDetail
PUT/locations/{id}/locationeqdetail/{locationeqdetailid}{?datasource}

Updates eq detail

Example URI

PUT /api/v1/locations/id/locationeqdetail/locationeqdetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationeqdetailid
number (required) 

ID number of the location earthquake record.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "yearUpgrade": "Hello, world!",
  "startDate": "Hello, world!",
  "completionDate": "Hello, world!",
  "yearSprinkler": "Hello, world!",
  "percentComplete": 1,
  "atcClass": "Hello, world!",
  "isoClass": "Hello, world!",
  "fireClass": "Hello, world!",
  "rmsClass": "Hello, world!",
  "userClass": "Hello, world!",
  "atcOccupancy": "Hello, world!",
  "isoOccupancy": "Hello, world!",
  "sicOccupancy": "Hello, world!",
  "ibcOccupancy": "Hello, world!",
  "userOccupancy": "Hello, world!",
  "secondarySupply": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqslSusceptibility": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "sprinklerType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "baseIsolation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "bldgExterior": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladding": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "constructQuality": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ductility": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "duress": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "enggFoundation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "frameBolt": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "hazardExposed": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "internalMasonaryPart": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "longSpan": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecEquip": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ornamentation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "overhangProfile": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "preFabrication": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "pounding": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "redundancy": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "shapeConfigure": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "shortColumn": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "sidingType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "storyProfile": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "structureUpgrade": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tank": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tiltupRetrofit": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "torsion": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "urmRetrofit": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wallsBrace": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tsDebris": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tsScour": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tsSafeDist": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tsProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "urmChimney": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "builtOnSlope": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "alquistPreoloZone": 1,
  "soil": 1,
  "landslide": 1,
  "liquefaction": 1,
  "biZone": 1,
  "landslideMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "liquefactionMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "soilMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "fireLossMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "landslideCov": 1,
  "liquefactionCov": 1,
  "soilCov": 1,
  "fireLossCov": 1,
  "soilPeriod": 1,
  "soilThickness": 1,
  "fire1": 1,
  "fire2": 1,
  "fire3": 1,
  "fire4": 1,
  "fire5": 1,
  "fire6": 1,
  "fire7": 1,
  "fire8": 1,
  "mmi100": 1,
  "mmi200": 1,
  "mmi250": 1,
  "mmi475": 1,
  "avgSlope": 1,
  "distFault1": 1,
  "apMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mmiMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "distSinkhole": 1,
  "distMine": 1,
  "sinkholeZone": 1,
  "soilVs": 1,
  "soilVsMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "basinLocId": 1,
  "di": 1,
  "critd": 1,
  "n160CS": 1,
  "t15": 1,
  "wff": 1,
  "distriv": 1,
  "gwd": 1,
  "dc": 1,
  "liqcv": 1,
  "hdLiqMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "phi": 1,
  "rough": 1,
  "ndvi": 1,
  "cohes": 1,
  "landcv": 1,
  "hdLandMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqSlope": 1,
  "elev": 1,
  "cti": 1,
  "precip": 1,
  "topo": 1,
  "hdSecMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "isValid": true,
  "eqslInsurance": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "completionDate": {
      "type": "string"
    },
    "yearSprinkler": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "atcClass": {
      "type": "string"
    },
    "isoClass": {
      "type": "string"
    },
    "fireClass": {
      "type": "string"
    },
    "rmsClass": {
      "type": "string"
    },
    "userClass": {
      "type": "string"
    },
    "atcOccupancy": {
      "type": "string"
    },
    "isoOccupancy": {
      "type": "string"
    },
    "sicOccupancy": {
      "type": "string"
    },
    "ibcOccupancy": {
      "type": "string"
    },
    "userOccupancy": {
      "type": "string"
    },
    "secondarySupply": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqslSusceptibility": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "sprinklerType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "baseIsolation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "bldgExterior": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladding": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "constructQuality": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ductility": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "duress": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "enggFoundation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "frameBolt": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "hazardExposed": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "internalMasonaryPart": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "longSpan": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecEquip": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ornamentation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "overhangProfile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "preFabrication": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "pounding": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "redundancy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "shapeConfigure": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "shortColumn": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "sidingType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "storyProfile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "structureUpgrade": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tank": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tiltupRetrofit": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "torsion": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "urmRetrofit": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wallsBrace": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tsDebris": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tsScour": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tsSafeDist": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tsProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "urmChimney": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "builtOnSlope": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "alquistPreoloZone": {
      "type": "number"
    },
    "soil": {
      "type": "number"
    },
    "landslide": {
      "type": "number"
    },
    "liquefaction": {
      "type": "number"
    },
    "biZone": {
      "type": "number"
    },
    "landslideMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "liquefactionMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "soilMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "fireLossMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "landslideCov": {
      "type": "number"
    },
    "liquefactionCov": {
      "type": "number"
    },
    "soilCov": {
      "type": "number"
    },
    "fireLossCov": {
      "type": "number"
    },
    "soilPeriod": {
      "type": "number"
    },
    "soilThickness": {
      "type": "number"
    },
    "fire1": {
      "type": "number"
    },
    "fire2": {
      "type": "number"
    },
    "fire3": {
      "type": "number"
    },
    "fire4": {
      "type": "number"
    },
    "fire5": {
      "type": "number"
    },
    "fire6": {
      "type": "number"
    },
    "fire7": {
      "type": "number"
    },
    "fire8": {
      "type": "number"
    },
    "mmi100": {
      "type": "number"
    },
    "mmi200": {
      "type": "number"
    },
    "mmi250": {
      "type": "number"
    },
    "mmi475": {
      "type": "number"
    },
    "avgSlope": {
      "type": "number"
    },
    "distFault1": {
      "type": "number"
    },
    "apMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mmiMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "distSinkhole": {
      "type": "number"
    },
    "distMine": {
      "type": "number"
    },
    "sinkholeZone": {
      "type": "number"
    },
    "soilVs": {
      "type": "number"
    },
    "soilVsMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "basinLocId": {
      "type": "number"
    },
    "di": {
      "type": "number"
    },
    "critd": {
      "type": "number"
    },
    "n160CS": {
      "type": "number"
    },
    "t15": {
      "type": "number"
    },
    "wff": {
      "type": "number"
    },
    "distriv": {
      "type": "number"
    },
    "gwd": {
      "type": "number"
    },
    "dc": {
      "type": "number"
    },
    "liqcv": {
      "type": "number"
    },
    "hdLiqMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "phi": {
      "type": "number"
    },
    "rough": {
      "type": "number"
    },
    "ndvi": {
      "type": "number"
    },
    "cohes": {
      "type": "number"
    },
    "landcv": {
      "type": "number"
    },
    "hdLandMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqSlope": {
      "type": "number"
    },
    "elev": {
      "type": "number"
    },
    "cti": {
      "type": "number"
    },
    "precip": {
      "type": "number"
    },
    "topo": {
      "type": "number"
    },
    "hdSecMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "isValid": {
      "type": "boolean"
    },
    "eqslInsurance": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}
Response  204
Response  404
HideShow

Not found. The resource referenced does not exist.

Headers
Content-Type: application/json
Body
{
  "links": [
    {
      "rel": "Hello, world!",
      "href": "Hello, world!",
      "method": "Hello, world!"
    }
  ],
  "meta": {
    "createdBy": "Hello, world!",
    "createdAt": "Hello, world!",
    "updatedBy": "Hello, world!",
    "updatedAt": "Hello, world!",
    "count": 1
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "links": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        },
        "updatedBy": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        },
        "count": {
          "type": "number"
        }
      }
    }
  },
  "required": [
    "links",
    "meta"
  ]
}

deleteLocationEqDetail
DELETE/locations/{id}/locationeqdetail/{locationeqdetailid}{?datasource}

Deletes a location eq detail

Example URI

DELETE /api/v1/locations/id/locationeqdetail/locationeqdetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationeqdetailid
number (required) 

ID number of the location earthquake record.

datasource
string (optional) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Locationfrdetail By Id

createLocationFrDetail
POST/locations/{id}/locationfrdetail{?datasource}

Create a new fr detail

Example URI

POST /api/v1/locations/id/locationfrdetail?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "yearUpgrade": "Hello, world!",
  "startDate": "Hello, world!",
  "completionDate": "Hello, world!",
  "percentComplete": 1,
  "fireDepartmentRatingModifier": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "fireDepartmentRating": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "sprinklerSystem": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "remoteAlarm": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "frPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "frProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "frSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "frSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wildFireHazard": 1,
  "wildFireSusceptibility": 1,
  "wildFireThreat": 1,
  "wildFireAreaDescription": 1,
  "wildFireSurfaceFuelType": "Hello, world!",
  "wildFireSpecialConditions": "Hello, world!",
  "wildFireLocalHistory": 1,
  "wildFireNearbyHistory": 1,
  "wildFireAccessibility": 1,
  "wildFireMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "completionDate": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "fireDepartmentRatingModifier": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "fireDepartmentRating": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "sprinklerSystem": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "remoteAlarm": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "frPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "frProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "frSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "frSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wildFireHazard": {
      "type": "number"
    },
    "wildFireSusceptibility": {
      "type": "number"
    },
    "wildFireThreat": {
      "type": "number"
    },
    "wildFireAreaDescription": {
      "type": "number"
    },
    "wildFireSurfaceFuelType": {
      "type": "string"
    },
    "wildFireSpecialConditions": {
      "type": "string"
    },
    "wildFireLocalHistory": {
      "type": "number"
    },
    "wildFireNearbyHistory": {
      "type": "number"
    },
    "wildFireAccessibility": {
      "type": "number"
    },
    "wildFireMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  201

Locations Locationfrdetail By Id

getLocationFrDetail
GET/locations/{id}/locationfrdetail/{locationfrdetailid}{?datasource}

Gets a location FR detail

Example URI

GET /api/v1/locations/id/locationfrdetail/locationfrdetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationfrdetailid
number (required) 

ID number of the location fire record.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "yearUpgrade": "Hello, world!",
  "startDate": "Hello, world!",
  "completionDate": "Hello, world!",
  "percentComplete": 1,
  "fireDepartmentRatingModifier": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "fireDepartmentRating": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "sprinklerSystem": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "remoteAlarm": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "frPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "frProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "frSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "frSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wildFireHazard": 1,
  "wildFireSusceptibility": 1,
  "wildFireThreat": 1,
  "wildFireAreaDescription": 1,
  "wildFireSurfaceFuelType": "Hello, world!",
  "wildFireSpecialConditions": "Hello, world!",
  "wildFireLocalHistory": 1,
  "wildFireNearbyHistory": 1,
  "wildFireAccessibility": 1,
  "wildFireMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "completionDate": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "fireDepartmentRatingModifier": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "fireDepartmentRating": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "sprinklerSystem": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "remoteAlarm": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "frPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "frProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "frSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "frSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wildFireHazard": {
      "type": "number"
    },
    "wildFireSusceptibility": {
      "type": "number"
    },
    "wildFireThreat": {
      "type": "number"
    },
    "wildFireAreaDescription": {
      "type": "number"
    },
    "wildFireSurfaceFuelType": {
      "type": "string"
    },
    "wildFireSpecialConditions": {
      "type": "string"
    },
    "wildFireLocalHistory": {
      "type": "number"
    },
    "wildFireNearbyHistory": {
      "type": "number"
    },
    "wildFireAccessibility": {
      "type": "number"
    },
    "wildFireMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updateLocationFrDetail
PUT/locations/{id}/locationfrdetail/{locationfrdetailid}{?datasource}

Updates fr detail

Example URI

PUT /api/v1/locations/id/locationfrdetail/locationfrdetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationfrdetailid
number (required) 

ID number of the location fire record.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "yearUpgrade": "Hello, world!",
  "startDate": "Hello, world!",
  "completionDate": "Hello, world!",
  "percentComplete": 1,
  "fireDepartmentRatingModifier": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "fireDepartmentRating": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "sprinklerSystem": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "remoteAlarm": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "frPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "frProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "frSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "frSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wildFireHazard": 1,
  "wildFireSusceptibility": 1,
  "wildFireThreat": 1,
  "wildFireAreaDescription": 1,
  "wildFireSurfaceFuelType": "Hello, world!",
  "wildFireSpecialConditions": "Hello, world!",
  "wildFireLocalHistory": 1,
  "wildFireNearbyHistory": 1,
  "wildFireAccessibility": 1,
  "wildFireMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "completionDate": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "fireDepartmentRatingModifier": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "fireDepartmentRating": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "sprinklerSystem": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "remoteAlarm": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "frPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "frProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "frSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "frSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wildFireHazard": {
      "type": "number"
    },
    "wildFireSusceptibility": {
      "type": "number"
    },
    "wildFireThreat": {
      "type": "number"
    },
    "wildFireAreaDescription": {
      "type": "number"
    },
    "wildFireSurfaceFuelType": {
      "type": "string"
    },
    "wildFireSpecialConditions": {
      "type": "string"
    },
    "wildFireLocalHistory": {
      "type": "number"
    },
    "wildFireNearbyHistory": {
      "type": "number"
    },
    "wildFireAccessibility": {
      "type": "number"
    },
    "wildFireMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  204
Response  404
HideShow
Body
Not found. The resource referenced does not exist.

deleteLocationFrDetail
DELETE/locations/{id}/locationfrdetail/{locationfrdetailid}{?datasource}

Deletes a location fr detail

Example URI

DELETE /api/v1/locations/id/locationfrdetail/locationfrdetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationfrdetailid
number (required) 

ID number of the location fire record.

datasource
string (optional) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Locationfldetail By Id

createLocationFlDetail
POST/locations/{id}/locationfldetail{?datasource}

Create a new fl detail

Example URI

POST /api/v1/locations/id/locationfldetail?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "yearUpgrade": "Hello, world!",
  "startDate": "Hello, world!",
  "completionDate": "Hello, world!",
  "percentComplete": 1,
  "isValid": true,
  "floodProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floorType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodMissile": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "basement": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodVulnerability": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecGround": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "foundation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "duration": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "contamination": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "velocity": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ifmVerticalExpDist": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flFoundationType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodIndex": 1,
  "elevation": 1,
  "elevationCov": 1,
  "annProb": "Hello, world!",
  "flZone": "Hello, world!",
  "bfe": "Hello, world!",
  "additionalInfo": "Hello, world!",
  "panel": "Hello, world!",
  "cobra": "Hello, world!",
  "floodWay": "Hello, world!",
  "sfha": "Hello, world!",
  "community": "Hello, world!",
  "confidence": 1,
  "underRev": "Hello, world!",
  "panelDate": "Hello, world!",
  "buffer": 1,
  "otherZones": "Hello, world!",
  "huZones": "Hello, world!",
  "mapSource": 1,
  "flMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "finishedFloor": 1,
  "userId1": "Hello, world!",
  "userId2": "Hello, world!",
  "basinName": "Hello, world!",
  "catchmentId": 1,
  "floodDriver": "Hello, world!",
  "rms100Flzone": 1,
  "rms500Flzone": 1,
  "fl50YrRpDef": 1,
  "fl75YrRpDef": 1,
  "fl100YrRpDef": 1,
  "fl200YrRpDef": 1,
  "fl250YrRpDef": 1,
  "fl500YrRpDef": 1,
  "fl1000YrRpDef": 1,
  "fl10000YrRpDef": 1,
  "fl50YrRpUndef": 1,
  "fl75YrRpUndef": 1,
  "fl100YrRpUndef": 1,
  "fl200YrRpUndef": 1,
  "fl250YrRpUndef": 1,
  "fl500YrRpUndef": 1,
  "fl1000YrRpUndef": 1,
  "fl10000YrRpUndef": 1,
  "hdFlMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flFfHag": 1,
  "flFfHagFlag": 1,
  "flZoneGroup": 1,
  "flPerBasement": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "completionDate": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    },
    "floodProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floorType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodMissile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "basement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodVulnerability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecGround": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "foundation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "duration": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "contamination": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "velocity": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ifmVerticalExpDist": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flFoundationType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodIndex": {
      "type": "number"
    },
    "elevation": {
      "type": "number"
    },
    "elevationCov": {
      "type": "number"
    },
    "annProb": {
      "type": "string"
    },
    "flZone": {
      "type": "string"
    },
    "bfe": {
      "type": "string"
    },
    "additionalInfo": {
      "type": "string"
    },
    "panel": {
      "type": "string"
    },
    "cobra": {
      "type": "string"
    },
    "floodWay": {
      "type": "string"
    },
    "sfha": {
      "type": "string"
    },
    "community": {
      "type": "string"
    },
    "confidence": {
      "type": "number"
    },
    "underRev": {
      "type": "string"
    },
    "panelDate": {
      "type": "string"
    },
    "buffer": {
      "type": "number"
    },
    "otherZones": {
      "type": "string"
    },
    "huZones": {
      "type": "string"
    },
    "mapSource": {
      "type": "number"
    },
    "flMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "finishedFloor": {
      "type": "number"
    },
    "userId1": {
      "type": "string"
    },
    "userId2": {
      "type": "string"
    },
    "basinName": {
      "type": "string"
    },
    "catchmentId": {
      "type": "number"
    },
    "floodDriver": {
      "type": "string"
    },
    "rms100Flzone": {
      "type": "number"
    },
    "rms500Flzone": {
      "type": "number"
    },
    "fl50YrRpDef": {
      "type": "number"
    },
    "fl75YrRpDef": {
      "type": "number"
    },
    "fl100YrRpDef": {
      "type": "number"
    },
    "fl200YrRpDef": {
      "type": "number"
    },
    "fl250YrRpDef": {
      "type": "number"
    },
    "fl500YrRpDef": {
      "type": "number"
    },
    "fl1000YrRpDef": {
      "type": "number"
    },
    "fl10000YrRpDef": {
      "type": "number"
    },
    "fl50YrRpUndef": {
      "type": "number"
    },
    "fl75YrRpUndef": {
      "type": "number"
    },
    "fl100YrRpUndef": {
      "type": "number"
    },
    "fl200YrRpUndef": {
      "type": "number"
    },
    "fl250YrRpUndef": {
      "type": "number"
    },
    "fl500YrRpUndef": {
      "type": "number"
    },
    "fl1000YrRpUndef": {
      "type": "number"
    },
    "fl10000YrRpUndef": {
      "type": "number"
    },
    "hdFlMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flFfHag": {
      "type": "number"
    },
    "flFfHagFlag": {
      "type": "number"
    },
    "flZoneGroup": {
      "type": "number"
    },
    "flPerBasement": {
      "type": "number"
    }
  }
}
Response  201

Locations Locationfldetail By Id

getLocationFlDetail
GET/locations/{id}/locationfldetail/{locationfldetailid}{?datasource}

Gets a location FL detail

Example URI

GET /api/v1/locations/id/locationfldetail/locationfldetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationfldetailid
number (required) 

ID number of the location flood record.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "yearUpgrade": "Hello, world!",
  "startDate": "Hello, world!",
  "completionDate": "Hello, world!",
  "percentComplete": 1,
  "isValid": true,
  "floodProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floorType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodMissile": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "basement": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodVulnerability": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecGround": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "foundation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "duration": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "contamination": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "velocity": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ifmVerticalExpDist": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flFoundationType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodIndex": 1,
  "elevation": 1,
  "elevationCov": 1,
  "annProb": "Hello, world!",
  "flZone": "Hello, world!",
  "bfe": "Hello, world!",
  "additionalInfo": "Hello, world!",
  "panel": "Hello, world!",
  "cobra": "Hello, world!",
  "floodWay": "Hello, world!",
  "sfha": "Hello, world!",
  "community": "Hello, world!",
  "confidence": 1,
  "underRev": "Hello, world!",
  "panelDate": "Hello, world!",
  "buffer": 1,
  "otherZones": "Hello, world!",
  "huZones": "Hello, world!",
  "mapSource": 1,
  "flMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "finishedFloor": 1,
  "userId1": "Hello, world!",
  "userId2": "Hello, world!",
  "basinName": "Hello, world!",
  "catchmentId": 1,
  "floodDriver": "Hello, world!",
  "rms100Flzone": 1,
  "rms500Flzone": 1,
  "fl50YrRpDef": 1,
  "fl75YrRpDef": 1,
  "fl100YrRpDef": 1,
  "fl200YrRpDef": 1,
  "fl250YrRpDef": 1,
  "fl500YrRpDef": 1,
  "fl1000YrRpDef": 1,
  "fl10000YrRpDef": 1,
  "fl50YrRpUndef": 1,
  "fl75YrRpUndef": 1,
  "fl100YrRpUndef": 1,
  "fl200YrRpUndef": 1,
  "fl250YrRpUndef": 1,
  "fl500YrRpUndef": 1,
  "fl1000YrRpUndef": 1,
  "fl10000YrRpUndef": 1,
  "hdFlMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flFfHag": 1,
  "flFfHagFlag": 1,
  "flZoneGroup": 1,
  "flPerBasement": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "completionDate": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    },
    "floodProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floorType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodMissile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "basement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodVulnerability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecGround": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "foundation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "duration": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "contamination": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "velocity": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ifmVerticalExpDist": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flFoundationType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodIndex": {
      "type": "number"
    },
    "elevation": {
      "type": "number"
    },
    "elevationCov": {
      "type": "number"
    },
    "annProb": {
      "type": "string"
    },
    "flZone": {
      "type": "string"
    },
    "bfe": {
      "type": "string"
    },
    "additionalInfo": {
      "type": "string"
    },
    "panel": {
      "type": "string"
    },
    "cobra": {
      "type": "string"
    },
    "floodWay": {
      "type": "string"
    },
    "sfha": {
      "type": "string"
    },
    "community": {
      "type": "string"
    },
    "confidence": {
      "type": "number"
    },
    "underRev": {
      "type": "string"
    },
    "panelDate": {
      "type": "string"
    },
    "buffer": {
      "type": "number"
    },
    "otherZones": {
      "type": "string"
    },
    "huZones": {
      "type": "string"
    },
    "mapSource": {
      "type": "number"
    },
    "flMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "finishedFloor": {
      "type": "number"
    },
    "userId1": {
      "type": "string"
    },
    "userId2": {
      "type": "string"
    },
    "basinName": {
      "type": "string"
    },
    "catchmentId": {
      "type": "number"
    },
    "floodDriver": {
      "type": "string"
    },
    "rms100Flzone": {
      "type": "number"
    },
    "rms500Flzone": {
      "type": "number"
    },
    "fl50YrRpDef": {
      "type": "number"
    },
    "fl75YrRpDef": {
      "type": "number"
    },
    "fl100YrRpDef": {
      "type": "number"
    },
    "fl200YrRpDef": {
      "type": "number"
    },
    "fl250YrRpDef": {
      "type": "number"
    },
    "fl500YrRpDef": {
      "type": "number"
    },
    "fl1000YrRpDef": {
      "type": "number"
    },
    "fl10000YrRpDef": {
      "type": "number"
    },
    "fl50YrRpUndef": {
      "type": "number"
    },
    "fl75YrRpUndef": {
      "type": "number"
    },
    "fl100YrRpUndef": {
      "type": "number"
    },
    "fl200YrRpUndef": {
      "type": "number"
    },
    "fl250YrRpUndef": {
      "type": "number"
    },
    "fl500YrRpUndef": {
      "type": "number"
    },
    "fl1000YrRpUndef": {
      "type": "number"
    },
    "fl10000YrRpUndef": {
      "type": "number"
    },
    "hdFlMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flFfHag": {
      "type": "number"
    },
    "flFfHagFlag": {
      "type": "number"
    },
    "flZoneGroup": {
      "type": "number"
    },
    "flPerBasement": {
      "type": "number"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updateLocationFlDetail
PUT/locations/{id}/locationfldetail/{locationfldetailid}{?datasource}

Updates fl detail

Example URI

PUT /api/v1/locations/id/locationfldetail/locationfldetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationfldetailid
number (required) 

ID number of the location flood record.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "yearUpgrade": "Hello, world!",
  "startDate": "Hello, world!",
  "completionDate": "Hello, world!",
  "percentComplete": 1,
  "isValid": true,
  "floodProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floorType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodMissile": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "basement": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodVulnerability": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecGround": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "foundation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "duration": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "contamination": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "velocity": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ifmVerticalExpDist": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flFoundationType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodIndex": 1,
  "elevation": 1,
  "elevationCov": 1,
  "annProb": "Hello, world!",
  "flZone": "Hello, world!",
  "bfe": "Hello, world!",
  "additionalInfo": "Hello, world!",
  "panel": "Hello, world!",
  "cobra": "Hello, world!",
  "floodWay": "Hello, world!",
  "sfha": "Hello, world!",
  "community": "Hello, world!",
  "confidence": 1,
  "underRev": "Hello, world!",
  "panelDate": "Hello, world!",
  "buffer": 1,
  "otherZones": "Hello, world!",
  "huZones": "Hello, world!",
  "mapSource": 1,
  "flMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "finishedFloor": 1,
  "userId1": "Hello, world!",
  "userId2": "Hello, world!",
  "basinName": "Hello, world!",
  "catchmentId": 1,
  "floodDriver": "Hello, world!",
  "rms100Flzone": 1,
  "rms500Flzone": 1,
  "fl50YrRpDef": 1,
  "fl75YrRpDef": 1,
  "fl100YrRpDef": 1,
  "fl200YrRpDef": 1,
  "fl250YrRpDef": 1,
  "fl500YrRpDef": 1,
  "fl1000YrRpDef": 1,
  "fl10000YrRpDef": 1,
  "fl50YrRpUndef": 1,
  "fl75YrRpUndef": 1,
  "fl100YrRpUndef": 1,
  "fl200YrRpUndef": 1,
  "fl250YrRpUndef": 1,
  "fl500YrRpUndef": 1,
  "fl1000YrRpUndef": 1,
  "fl10000YrRpUndef": 1,
  "hdFlMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flFfHag": 1,
  "flFfHagFlag": 1,
  "flZoneGroup": 1,
  "flPerBasement": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "completionDate": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    },
    "floodProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floorType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodMissile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "basement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodVulnerability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecGround": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "foundation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "duration": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "contamination": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "velocity": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ifmVerticalExpDist": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flFoundationType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodIndex": {
      "type": "number"
    },
    "elevation": {
      "type": "number"
    },
    "elevationCov": {
      "type": "number"
    },
    "annProb": {
      "type": "string"
    },
    "flZone": {
      "type": "string"
    },
    "bfe": {
      "type": "string"
    },
    "additionalInfo": {
      "type": "string"
    },
    "panel": {
      "type": "string"
    },
    "cobra": {
      "type": "string"
    },
    "floodWay": {
      "type": "string"
    },
    "sfha": {
      "type": "string"
    },
    "community": {
      "type": "string"
    },
    "confidence": {
      "type": "number"
    },
    "underRev": {
      "type": "string"
    },
    "panelDate": {
      "type": "string"
    },
    "buffer": {
      "type": "number"
    },
    "otherZones": {
      "type": "string"
    },
    "huZones": {
      "type": "string"
    },
    "mapSource": {
      "type": "number"
    },
    "flMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "finishedFloor": {
      "type": "number"
    },
    "userId1": {
      "type": "string"
    },
    "userId2": {
      "type": "string"
    },
    "basinName": {
      "type": "string"
    },
    "catchmentId": {
      "type": "number"
    },
    "floodDriver": {
      "type": "string"
    },
    "rms100Flzone": {
      "type": "number"
    },
    "rms500Flzone": {
      "type": "number"
    },
    "fl50YrRpDef": {
      "type": "number"
    },
    "fl75YrRpDef": {
      "type": "number"
    },
    "fl100YrRpDef": {
      "type": "number"
    },
    "fl200YrRpDef": {
      "type": "number"
    },
    "fl250YrRpDef": {
      "type": "number"
    },
    "fl500YrRpDef": {
      "type": "number"
    },
    "fl1000YrRpDef": {
      "type": "number"
    },
    "fl10000YrRpDef": {
      "type": "number"
    },
    "fl50YrRpUndef": {
      "type": "number"
    },
    "fl75YrRpUndef": {
      "type": "number"
    },
    "fl100YrRpUndef": {
      "type": "number"
    },
    "fl200YrRpUndef": {
      "type": "number"
    },
    "fl250YrRpUndef": {
      "type": "number"
    },
    "fl500YrRpUndef": {
      "type": "number"
    },
    "fl1000YrRpUndef": {
      "type": "number"
    },
    "fl10000YrRpUndef": {
      "type": "number"
    },
    "hdFlMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flFfHag": {
      "type": "number"
    },
    "flFfHagFlag": {
      "type": "number"
    },
    "flZoneGroup": {
      "type": "number"
    },
    "flPerBasement": {
      "type": "number"
    }
  }
}
Response  204
Response  404
HideShow
Body
Not found. The resource referenced does not exist.

deleteLocationFlDetail
DELETE/locations/{id}/locationfldetail/{locationfldetailid}{?datasource}

Deletes a location fl detail

Example URI

DELETE /api/v1/locations/id/locationfldetail/locationfldetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationfldetailid
number (required) 

ID number of the location flood record.

datasource
string (optional) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Rfluest

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Locationtodetail By Id

createLocationToDetail
POST/locations/{id}/locationtodetail{?datasource}

Create a new to detail

Example URI

POST /api/v1/locations/id/locationtodetail?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "yearUpgrade": "Hello, world!",
  "percentComplete": 1,
  "fireClass": "Hello, world!",
  "rmsClass": "Hello, world!",
  "userClass": "Hello, world!",
  "atcOccupancy": "Hello, world!",
  "isoOccupancy": "Hello, world!",
  "userOccupancy": "Hello, world!",
  "isValid": true,
  "architecture": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladRate": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "constructQuality": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "designCode": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "doorOpenings": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "externalOrnament": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodVulnerability": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "foundation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "maintenance": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecSide": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "otherOpenings": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofAge": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofAnchor": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofEquipment": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofFrame": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofGeometry": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofParpet": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofSystem": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windMissile": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windVulnerability": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "basement": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecGround": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodMissiles": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodProtection": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "iceDamProtection": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "plumbingInsulation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "atticInsulation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofVentilation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "snowGuards": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "treeDensity": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "garaging": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "toPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "toProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "toSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "toSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "fireClass": {
      "type": "string"
    },
    "rmsClass": {
      "type": "string"
    },
    "userClass": {
      "type": "string"
    },
    "atcOccupancy": {
      "type": "string"
    },
    "isoOccupancy": {
      "type": "string"
    },
    "userOccupancy": {
      "type": "string"
    },
    "isValid": {
      "type": "boolean"
    },
    "architecture": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladRate": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "constructQuality": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "designCode": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "doorOpenings": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "externalOrnament": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodVulnerability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "foundation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "maintenance": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecSide": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "otherOpenings": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofAge": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofAnchor": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofEquipment": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofFrame": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofGeometry": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofParpet": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofSystem": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windMissile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windVulnerability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "basement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecGround": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodMissiles": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodProtection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "iceDamProtection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "plumbingInsulation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "atticInsulation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofVentilation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "snowGuards": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "treeDensity": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "garaging": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "toPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "toProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "toSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "toSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}
Response  201

Locations Locationtodetail By Id

getLocationToDetail
GET/locations/{id}/locationtodetail/{locationtodetailid}{?datasource}

Gets a location TO detail

Example URI

GET /api/v1/locations/id/locationtodetail/locationtodetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationtodetailid
number (required) 

ID number of the location tornado record.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "yearUpgrade": "Hello, world!",
  "percentComplete": 1,
  "fireClass": "Hello, world!",
  "rmsClass": "Hello, world!",
  "userClass": "Hello, world!",
  "atcOccupancy": "Hello, world!",
  "isoOccupancy": "Hello, world!",
  "userOccupancy": "Hello, world!",
  "isValid": true,
  "architecture": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladRate": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "constructQuality": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "designCode": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "doorOpenings": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "externalOrnament": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodVulnerability": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "foundation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "maintenance": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecSide": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "otherOpenings": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofAge": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofAnchor": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofEquipment": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofFrame": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofGeometry": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofParpet": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofSystem": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windMissile": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windVulnerability": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "basement": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecGround": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodMissiles": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodProtection": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "iceDamProtection": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "plumbingInsulation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "atticInsulation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofVentilation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "snowGuards": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "treeDensity": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "garaging": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "toPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "toProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "toSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "toSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "fireClass": {
      "type": "string"
    },
    "rmsClass": {
      "type": "string"
    },
    "userClass": {
      "type": "string"
    },
    "atcOccupancy": {
      "type": "string"
    },
    "isoOccupancy": {
      "type": "string"
    },
    "userOccupancy": {
      "type": "string"
    },
    "isValid": {
      "type": "boolean"
    },
    "architecture": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladRate": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "constructQuality": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "designCode": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "doorOpenings": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "externalOrnament": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodVulnerability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "foundation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "maintenance": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecSide": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "otherOpenings": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofAge": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofAnchor": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofEquipment": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofFrame": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofGeometry": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofParpet": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofSystem": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windMissile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windVulnerability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "basement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecGround": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodMissiles": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodProtection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "iceDamProtection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "plumbingInsulation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "atticInsulation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofVentilation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "snowGuards": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "treeDensity": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "garaging": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "toPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "toProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "toSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "toSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updateLocationToDetail
PUT/locations/{id}/locationtodetail/{locationtodetailid}{?datasource}

Updates to detail

Example URI

PUT /api/v1/locations/id/locationtodetail/locationtodetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationtodetailid
number (required) 

ID number of the location tornado record.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "yearUpgrade": "Hello, world!",
  "percentComplete": 1,
  "fireClass": "Hello, world!",
  "rmsClass": "Hello, world!",
  "userClass": "Hello, world!",
  "atcOccupancy": "Hello, world!",
  "isoOccupancy": "Hello, world!",
  "userOccupancy": "Hello, world!",
  "isValid": true,
  "architecture": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladRate": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "constructQuality": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "designCode": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "doorOpenings": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "externalOrnament": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodVulnerability": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "foundation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "maintenance": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecSide": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "otherOpenings": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofAge": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofAnchor": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofEquipment": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofFrame": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofGeometry": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofParpet": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofSystem": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windMissile": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windVulnerability": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "basement": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecGround": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodMissiles": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodProtection": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "iceDamProtection": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "plumbingInsulation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "atticInsulation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofVentilation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "snowGuards": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "treeDensity": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "garaging": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "toPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "toProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "toSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "toSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "fireClass": {
      "type": "string"
    },
    "rmsClass": {
      "type": "string"
    },
    "userClass": {
      "type": "string"
    },
    "atcOccupancy": {
      "type": "string"
    },
    "isoOccupancy": {
      "type": "string"
    },
    "userOccupancy": {
      "type": "string"
    },
    "isValid": {
      "type": "boolean"
    },
    "architecture": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladRate": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "constructQuality": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "designCode": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "doorOpenings": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "externalOrnament": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodVulnerability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "foundation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "maintenance": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecSide": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "otherOpenings": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofAge": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofAnchor": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofEquipment": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofFrame": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofGeometry": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofParpet": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofSystem": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windMissile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windVulnerability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "basement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecGround": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodMissiles": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodProtection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "iceDamProtection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "plumbingInsulation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "atticInsulation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofVentilation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "snowGuards": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "treeDensity": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "garaging": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "toPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "toProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "toSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "toSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}
Response  204
Response  404
HideShow

Not found. The resource referenced does not exist.

Headers
Content-Type: application/json
Body
{
  "links": [
    {
      "rel": "Hello, world!",
      "href": "Hello, world!",
      "method": "Hello, world!"
    }
  ],
  "meta": {
    "createdBy": "Hello, world!",
    "createdAt": "Hello, world!",
    "updatedBy": "Hello, world!",
    "updatedAt": "Hello, world!",
    "count": 1
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "links": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        },
        "updatedBy": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        },
        "count": {
          "type": "number"
        }
      }
    }
  },
  "required": [
    "links",
    "meta"
  ]
}

deleteLocationToDetail
DELETE/locations/{id}/locationtodetail/{locationtodetailid}{?datasource}

Deletes a location to detail

Example URI

DELETE /api/v1/locations/id/locationtodetail/locationtodetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationtodetailid
number (required) 

ID number of the location tornado record.

datasource
string (optional) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Buildingattribute By Id

createBuildingAttribute
POST/locations/{id}/buildingattribute{?datasource}

Create a new building attribute

Example URI

POST /api/v1/locations/id/buildingattribute?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "buildingId": "Hello, world!",
  "buildingNumber": "Hello, world!",
  "streetPrefix": "Hello, world!",
  "streetName": "Hello, world!",
  "streetType": "Hello, world!",
  "streetSuffix": "Hello, world!",
  "cityName": "Hello, world!",
  "stateCode": "Hello, world!",
  "country": "Hello, world!",
  "latitude": 1,
  "longitude": 1,
  "buildingClassScheme": "RMS",
  "occupancyTypeScheme": "ATC",
  "derivedStories": 1,
  "areaUnit": "SqFeet",
  "yearRange": 1,
  "exterior": "Hello, world!",
  "fireproof": "Hello, world!",
  "esdbBuildingName": "Hello, world!",
  "esdbBuildingClass": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "esdbOccupancyType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "esdbBldgHeight": 1,
  "esdbStories": 1,
  "esdbSquareFootage": 1,
  "esdbYearBuilt": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "buildingId": {
      "type": "string"
    },
    "buildingNumber": {
      "type": "string"
    },
    "streetPrefix": {
      "type": "string"
    },
    "streetName": {
      "type": "string"
    },
    "streetType": {
      "type": "string"
    },
    "streetSuffix": {
      "type": "string"
    },
    "cityName": {
      "type": "string"
    },
    "stateCode": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "latitude": {
      "type": "number"
    },
    "longitude": {
      "type": "number"
    },
    "buildingClassScheme": {
      "type": "string",
      "enum": [
        "RMS",
        "ATC",
        "ISO",
        "FIRE",
        "RMS_IND",
        "JPBLDG",
        "EURO",
        "RMS_BR",
        "RMS_OP",
        "USER"
      ]
    },
    "occupancyTypeScheme": {
      "type": "string",
      "enum": [
        "ATC",
        "SIC",
        "NAICS",
        "NCCI",
        "ISO",
        "IBC",
        "RMS_IND",
        "JPOCC",
        "EURO",
        "RMS_BR",
        "RMS_OP",
        "WOCC"
      ]
    },
    "derivedStories": {
      "type": "number"
    },
    "areaUnit": {
      "type": "string",
      "enum": [
        "SqFeet",
        "SqMeter"
      ]
    },
    "yearRange": {
      "type": "number"
    },
    "exterior": {
      "type": "string"
    },
    "fireproof": {
      "type": "string"
    },
    "esdbBuildingName": {
      "type": "string"
    },
    "esdbBuildingClass": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "esdbOccupancyType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "esdbBldgHeight": {
      "type": "number"
    },
    "esdbStories": {
      "type": "number"
    },
    "esdbSquareFootage": {
      "type": "number"
    },
    "esdbYearBuilt": {
      "type": "string"
    }
  }
}
Response  201

Locations Buildingattribute By Id

updateBuildingAttribute
PUT/locations/{id}/buildingattribute/{buildingattributeid}{?datasource}

Updates building attribute

Example URI

PUT /api/v1/locations/id/buildingattribute/buildingattributeid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

buildingattributeid
number (required) 

ID number of the location building attribute record.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "buildingId": "Hello, world!",
  "buildingNumber": "Hello, world!",
  "streetPrefix": "Hello, world!",
  "streetName": "Hello, world!",
  "streetType": "Hello, world!",
  "streetSuffix": "Hello, world!",
  "cityName": "Hello, world!",
  "stateCode": "Hello, world!",
  "country": "Hello, world!",
  "latitude": 1,
  "longitude": 1,
  "buildingClassScheme": "RMS",
  "occupancyTypeScheme": "ATC",
  "derivedStories": 1,
  "areaUnit": "SqFeet",
  "yearRange": 1,
  "exterior": "Hello, world!",
  "fireproof": "Hello, world!",
  "esdbBuildingName": "Hello, world!",
  "esdbBuildingClass": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "esdbOccupancyType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "esdbBldgHeight": 1,
  "esdbStories": 1,
  "esdbSquareFootage": 1,
  "esdbYearBuilt": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "buildingId": {
      "type": "string"
    },
    "buildingNumber": {
      "type": "string"
    },
    "streetPrefix": {
      "type": "string"
    },
    "streetName": {
      "type": "string"
    },
    "streetType": {
      "type": "string"
    },
    "streetSuffix": {
      "type": "string"
    },
    "cityName": {
      "type": "string"
    },
    "stateCode": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "latitude": {
      "type": "number"
    },
    "longitude": {
      "type": "number"
    },
    "buildingClassScheme": {
      "type": "string",
      "enum": [
        "RMS",
        "ATC",
        "ISO",
        "FIRE",
        "RMS_IND",
        "JPBLDG",
        "EURO",
        "RMS_BR",
        "RMS_OP",
        "USER"
      ]
    },
    "occupancyTypeScheme": {
      "type": "string",
      "enum": [
        "ATC",
        "SIC",
        "NAICS",
        "NCCI",
        "ISO",
        "IBC",
        "RMS_IND",
        "JPOCC",
        "EURO",
        "RMS_BR",
        "RMS_OP",
        "WOCC"
      ]
    },
    "derivedStories": {
      "type": "number"
    },
    "areaUnit": {
      "type": "string",
      "enum": [
        "SqFeet",
        "SqMeter"
      ]
    },
    "yearRange": {
      "type": "number"
    },
    "exterior": {
      "type": "string"
    },
    "fireproof": {
      "type": "string"
    },
    "esdbBuildingName": {
      "type": "string"
    },
    "esdbBuildingClass": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "esdbOccupancyType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "esdbBldgHeight": {
      "type": "number"
    },
    "esdbStories": {
      "type": "number"
    },
    "esdbSquareFootage": {
      "type": "number"
    },
    "esdbYearBuilt": {
      "type": "string"
    }
  }
}
Response  204
Response  404
HideShow

Not found. The resource referenced does not exist.

Headers
Content-Type: application/json
Body
{
  "links": [
    {
      "rel": "Hello, world!",
      "href": "Hello, world!",
      "method": "Hello, world!"
    }
  ],
  "meta": {
    "createdBy": "Hello, world!",
    "createdAt": "Hello, world!",
    "updatedBy": "Hello, world!",
    "updatedAt": "Hello, world!",
    "count": 1
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "links": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        },
        "updatedBy": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        },
        "count": {
          "type": "number"
        }
      }
    }
  },
  "required": [
    "links",
    "meta"
  ]
}

deleteBuildingAttribute
DELETE/locations/{id}/buildingattribute/{buildingattributeid}{?datasource}

Deletes a building attribute

Example URI

DELETE /api/v1/locations/id/buildingattribute/buildingattributeid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

buildingattributeid
number (required) 

ID number of the location building attribute record.

datasource
string (optional) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Locationcondition Batch

batchProcessLocationConditions
POST/locations/locationcondition/batch{?datasource}

Runs creating/updating/deleting location conditions in a batch.

Example URI

POST /api/v1/locations/locationcondition/batch?datasource=
URI Parameters
HideShow
datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "method": "Hello, world!",
    "path": "Hello, world!",
    "body": "Hello, world!"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  201
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Locationcondition By Id

createLocationCondition
POST/locations/{id}/locationcondition{?datasource}

Create a new location condition

Example URI

POST /api/v1/locations/id/locationcondition?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "locationId": 1,
  "conditionId": 1,
  "isIncluded": "NotIncluded"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "locationId": {
      "type": "number"
    },
    "conditionId": {
      "type": "number"
    },
    "isIncluded": {
      "type": "string",
      "enum": [
        "NotIncluded",
        "Included",
        "UserIncluded"
      ]
    }
  }
}
Response  201

Locations Locationcondition By Id

updateLocationCondition
PUT/locations/{id}/locationcondition/{conditionid}{?datasource}

Updates location condition

Example URI

PUT /api/v1/locations/id/locationcondition/conditionid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

conditionid
number (required) 

ID number of the location condition record.

datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "locationId": 1,
  "conditionId": 1,
  "isIncluded": "NotIncluded"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "locationId": {
      "type": "number"
    },
    "conditionId": {
      "type": "number"
    },
    "isIncluded": {
      "type": "string",
      "enum": [
        "NotIncluded",
        "Included",
        "UserIncluded"
      ]
    }
  }
}
Response  204
Response  404
HideShow

Not found. The resource referenced does not exist.

Headers
Content-Type: application/json
Body
{
  "links": [
    {
      "rel": "Hello, world!",
      "href": "Hello, world!",
      "method": "Hello, world!"
    }
  ],
  "meta": {
    "createdBy": "Hello, world!",
    "createdAt": "Hello, world!",
    "updatedBy": "Hello, world!",
    "updatedAt": "Hello, world!",
    "count": 1
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "links": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        },
        "updatedBy": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        },
        "count": {
          "type": "number"
        }
      }
    }
  },
  "required": [
    "links",
    "meta"
  ]
}

deleteLocationCondition
DELETE/locations/{id}/locationcondition/{conditionid}{?datasource}

Deletes a location condition

Example URI

DELETE /api/v1/locations/id/locationcondition/conditionid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

conditionid
number (required) 

ID number of the location condition record.

datasource
string (required) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Policyconditions By Id

getPolicyConditions
GET/locations/{id}/policyconditions{?datasource}

Retrieves policy conditions for a location

Example URI

GET /api/v1/locations/id/policyconditions?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (required) 

Name of the data source.

Response  200
HideShow

OK. Policy conditions successfully retrieved.

Headers
Content-Type: application/json
Body
[
  {
    "id": 1,
    "name": "Hello, world!",
    "isPredefined": true,
    "limit": 1,
    "deductible": 1,
    "deductibleType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "conditionType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "parentCondition": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "policyNumber": "Hello, world!",
    "policyConditionCriterias": [
      {
        "id": 1,
        "logic": "Hello, world!",
        "openPar": "Hello, world!",
        "field": "Hello, world!",
        "operator": "Hello, world!",
        "value": "Hello, world!",
        "closePar": "Hello, world!"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Locations Geocode By Id

geoCodeByLocationId
POST/locations/{id}/geocode{?datasource}

Geocodes a single location by ID.

Example URI

POST /api/v1/locations/id/geocode?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "empty": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "empty": {
      "type": "boolean"
    }
  }
}
Response  201
HideShow

Created. The location geocod request is created successfully.

Headers
Content-Type: application/json
Body
{
  "addressId": 1,
  "area": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "buildingId": "Hello, world!",
  "buildingName": "Hello, world!",
  "addressType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "country": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "countryScheme": "Hello, world!",
  "countryGeoId": 1,
  "countryRmsCode": "Hello, world!",
  "latitude": 1,
  "longitude": 1,
  "addressText": "Hello, world!",
  "streetAddress": "Hello, world!",
  "cityCode": "Hello, world!",
  "cityName": "Hello, world!",
  "cityGeoId": 1,
  "postalCode": "Hello, world!",
  "postalGeoId": 1,
  "block": "Hello, world!",
  "blockGroup": "Hello, world!",
  "locationCode": "Hello, world!",
  "locationCodeGeoId": 1,
  "parcelNumber": "Hello, world!",
  "subLocality": "Hello, world!",
  "geoResolutionConfidence": 1,
  "geoAccuracyBuffer": 1,
  "geoProductVersion": "Hello, world!",
  "geoLocationCode": "Hello, world!",
  "geoMatchCode": "Hello, world!",
  "geoDataSourceId": 1,
  "geoResolutionCode": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "geoDataSourceVersionId": 1,
  "geoDateTime": "Hello, world!",
  "createDateTime": "Hello, world!",
  "updateDateTime": "Hello, world!",
  "admin1Code": "Hello, world!",
  "admin1GeoId": 1,
  "admin1Name": "Hello, world!",
  "admin2Code": "Hello, world!",
  "admin2GeoId": 1,
  "admin2Name": "Hello, world!",
  "admin3Code": "Hello, world!",
  "admin3GeoId": 1,
  "admin3Name": "Hello, world!",
  "admin4Code": "Hello, world!",
  "admin4GeoId": 1,
  "admin4Name": "Hello, world!",
  "admin5Code": "Hello, world!",
  "admin5GeoId": 1,
  "admin5Name": "Hello, world!",
  "zone1GeoId": 1,
  "zone2GeoId": 1,
  "zone3GeoId": 1,
  "zone4GeoId": 1,
  "zone5GeoId": 1,
  "zone1": "Hello, world!",
  "zone2": "Hello, world!",
  "zone3": "Hello, world!",
  "zone3Name": "Hello, world!",
  "zone4Name": "Hello, world!",
  "zone5Name": "Hello, world!",
  "zone3Code": "Hello, world!",
  "zone4Code": "Hello, world!",
  "zone5Code": "Hello, world!",
  "ugid": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "addressId": {
      "type": "number"
    },
    "area": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "buildingId": {
      "type": "string"
    },
    "buildingName": {
      "type": "string"
    },
    "addressType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "country": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "countryScheme": {
      "type": "string"
    },
    "countryGeoId": {
      "type": "number"
    },
    "countryRmsCode": {
      "type": "string"
    },
    "latitude": {
      "type": "number"
    },
    "longitude": {
      "type": "number"
    },
    "addressText": {
      "type": "string"
    },
    "streetAddress": {
      "type": "string"
    },
    "cityCode": {
      "type": "string"
    },
    "cityName": {
      "type": "string"
    },
    "cityGeoId": {
      "type": "number"
    },
    "postalCode": {
      "type": "string"
    },
    "postalGeoId": {
      "type": "number"
    },
    "block": {
      "type": "string"
    },
    "blockGroup": {
      "type": "string"
    },
    "locationCode": {
      "type": "string"
    },
    "locationCodeGeoId": {
      "type": "number"
    },
    "parcelNumber": {
      "type": "string"
    },
    "subLocality": {
      "type": "string"
    },
    "geoResolutionConfidence": {
      "type": "number"
    },
    "geoAccuracyBuffer": {
      "type": "number"
    },
    "geoProductVersion": {
      "type": "string"
    },
    "geoLocationCode": {
      "type": "string"
    },
    "geoMatchCode": {
      "type": "string"
    },
    "geoDataSourceId": {
      "type": "number"
    },
    "geoResolutionCode": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "geoDataSourceVersionId": {
      "type": "number"
    },
    "geoDateTime": {
      "type": "string"
    },
    "createDateTime": {
      "type": "string"
    },
    "updateDateTime": {
      "type": "string"
    },
    "admin1Code": {
      "type": "string"
    },
    "admin1GeoId": {
      "type": "number"
    },
    "admin1Name": {
      "type": "string"
    },
    "admin2Code": {
      "type": "string"
    },
    "admin2GeoId": {
      "type": "number"
    },
    "admin2Name": {
      "type": "string"
    },
    "admin3Code": {
      "type": "string"
    },
    "admin3GeoId": {
      "type": "number"
    },
    "admin3Name": {
      "type": "string"
    },
    "admin4Code": {
      "type": "string"
    },
    "admin4GeoId": {
      "type": "number"
    },
    "admin4Name": {
      "type": "string"
    },
    "admin5Code": {
      "type": "string"
    },
    "admin5GeoId": {
      "type": "number"
    },
    "admin5Name": {
      "type": "string"
    },
    "zone1GeoId": {
      "type": "number"
    },
    "zone2GeoId": {
      "type": "number"
    },
    "zone3GeoId": {
      "type": "number"
    },
    "zone4GeoId": {
      "type": "number"
    },
    "zone5GeoId": {
      "type": "number"
    },
    "zone1": {
      "type": "string"
    },
    "zone2": {
      "type": "string"
    },
    "zone3": {
      "type": "string"
    },
    "zone3Name": {
      "type": "string"
    },
    "zone4Name": {
      "type": "string"
    },
    "zone5Name": {
      "type": "string"
    },
    "zone3Code": {
      "type": "string"
    },
    "zone4Code": {
      "type": "string"
    },
    "zone5Code": {
      "type": "string"
    },
    "ugid": {
      "type": "string"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Geocode

geoCodeByAddress
POST/locations/geocode

Geocodes a single location by address.

Example URI

POST /api/v1/locations/geocode
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "addressId": 1,
  "area": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "buildingId": "Hello, world!",
  "buildingName": "Hello, world!",
  "addressType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "country": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "countryScheme": "Hello, world!",
  "countryGeoId": 1,
  "countryRmsCode": "Hello, world!",
  "latitude": 1,
  "longitude": 1,
  "addressText": "Hello, world!",
  "streetAddress": "Hello, world!",
  "cityCode": "Hello, world!",
  "cityName": "Hello, world!",
  "cityGeoId": 1,
  "postalCode": "Hello, world!",
  "postalGeoId": 1,
  "block": "Hello, world!",
  "blockGroup": "Hello, world!",
  "locationCode": "Hello, world!",
  "locationCodeGeoId": 1,
  "parcelNumber": "Hello, world!",
  "subLocality": "Hello, world!",
  "geoResolutionConfidence": 1,
  "geoAccuracyBuffer": 1,
  "geoProductVersion": "Hello, world!",
  "geoLocationCode": "Hello, world!",
  "geoMatchCode": "Hello, world!",
  "geoDataSourceId": 1,
  "geoResolutionCode": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "geoDataSourceVersionId": 1,
  "geoDateTime": "Hello, world!",
  "createDateTime": "Hello, world!",
  "updateDateTime": "Hello, world!",
  "admin1Code": "Hello, world!",
  "admin1GeoId": 1,
  "admin1Name": "Hello, world!",
  "admin2Code": "Hello, world!",
  "admin2GeoId": 1,
  "admin2Name": "Hello, world!",
  "admin3Code": "Hello, world!",
  "admin3GeoId": 1,
  "admin3Name": "Hello, world!",
  "admin4Code": "Hello, world!",
  "admin4GeoId": 1,
  "admin4Name": "Hello, world!",
  "admin5Code": "Hello, world!",
  "admin5GeoId": 1,
  "admin5Name": "Hello, world!",
  "zone1GeoId": 1,
  "zone2GeoId": 1,
  "zone3GeoId": 1,
  "zone4GeoId": 1,
  "zone5GeoId": 1,
  "zone1": "Hello, world!",
  "zone2": "Hello, world!",
  "zone3": "Hello, world!",
  "zone3Name": "Hello, world!",
  "zone4Name": "Hello, world!",
  "zone5Name": "Hello, world!",
  "zone3Code": "Hello, world!",
  "zone4Code": "Hello, world!",
  "zone5Code": "Hello, world!",
  "ugid": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "addressId": {
      "type": "number"
    },
    "area": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "buildingId": {
      "type": "string"
    },
    "buildingName": {
      "type": "string"
    },
    "addressType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "country": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "countryScheme": {
      "type": "string"
    },
    "countryGeoId": {
      "type": "number"
    },
    "countryRmsCode": {
      "type": "string"
    },
    "latitude": {
      "type": "number"
    },
    "longitude": {
      "type": "number"
    },
    "addressText": {
      "type": "string"
    },
    "streetAddress": {
      "type": "string"
    },
    "cityCode": {
      "type": "string"
    },
    "cityName": {
      "type": "string"
    },
    "cityGeoId": {
      "type": "number"
    },
    "postalCode": {
      "type": "string"
    },
    "postalGeoId": {
      "type": "number"
    },
    "block": {
      "type": "string"
    },
    "blockGroup": {
      "type": "string"
    },
    "locationCode": {
      "type": "string"
    },
    "locationCodeGeoId": {
      "type": "number"
    },
    "parcelNumber": {
      "type": "string"
    },
    "subLocality": {
      "type": "string"
    },
    "geoResolutionConfidence": {
      "type": "number"
    },
    "geoAccuracyBuffer": {
      "type": "number"
    },
    "geoProductVersion": {
      "type": "string"
    },
    "geoLocationCode": {
      "type": "string"
    },
    "geoMatchCode": {
      "type": "string"
    },
    "geoDataSourceId": {
      "type": "number"
    },
    "geoResolutionCode": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "geoDataSourceVersionId": {
      "type": "number"
    },
    "geoDateTime": {
      "type": "string"
    },
    "createDateTime": {
      "type": "string"
    },
    "updateDateTime": {
      "type": "string"
    },
    "admin1Code": {
      "type": "string"
    },
    "admin1GeoId": {
      "type": "number"
    },
    "admin1Name": {
      "type": "string"
    },
    "admin2Code": {
      "type": "string"
    },
    "admin2GeoId": {
      "type": "number"
    },
    "admin2Name": {
      "type": "string"
    },
    "admin3Code": {
      "type": "string"
    },
    "admin3GeoId": {
      "type": "number"
    },
    "admin3Name": {
      "type": "string"
    },
    "admin4Code": {
      "type": "string"
    },
    "admin4GeoId": {
      "type": "number"
    },
    "admin4Name": {
      "type": "string"
    },
    "admin5Code": {
      "type": "string"
    },
    "admin5GeoId": {
      "type": "number"
    },
    "admin5Name": {
      "type": "string"
    },
    "zone1GeoId": {
      "type": "number"
    },
    "zone2GeoId": {
      "type": "number"
    },
    "zone3GeoId": {
      "type": "number"
    },
    "zone4GeoId": {
      "type": "number"
    },
    "zone5GeoId": {
      "type": "number"
    },
    "zone1": {
      "type": "string"
    },
    "zone2": {
      "type": "string"
    },
    "zone3": {
      "type": "string"
    },
    "zone3Name": {
      "type": "string"
    },
    "zone4Name": {
      "type": "string"
    },
    "zone5Name": {
      "type": "string"
    },
    "zone3Code": {
      "type": "string"
    },
    "zone4Code": {
      "type": "string"
    },
    "zone5Code": {
      "type": "string"
    },
    "ugid": {
      "type": "string"
    }
  }
}
Response  200
HideShow

OK. The geocoding of the address is successfully performed.

Headers
Content-Type: application/json
Body
{
  "addressId": 1,
  "area": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "buildingId": "Hello, world!",
  "buildingName": "Hello, world!",
  "addressType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "country": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "countryScheme": "Hello, world!",
  "countryGeoId": 1,
  "countryRmsCode": "Hello, world!",
  "latitude": 1,
  "longitude": 1,
  "addressText": "Hello, world!",
  "streetAddress": "Hello, world!",
  "cityCode": "Hello, world!",
  "cityName": "Hello, world!",
  "cityGeoId": 1,
  "postalCode": "Hello, world!",
  "postalGeoId": 1,
  "block": "Hello, world!",
  "blockGroup": "Hello, world!",
  "locationCode": "Hello, world!",
  "locationCodeGeoId": 1,
  "parcelNumber": "Hello, world!",
  "subLocality": "Hello, world!",
  "geoResolutionConfidence": 1,
  "geoAccuracyBuffer": 1,
  "geoProductVersion": "Hello, world!",
  "geoLocationCode": "Hello, world!",
  "geoMatchCode": "Hello, world!",
  "geoDataSourceId": 1,
  "geoResolutionCode": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "geoDataSourceVersionId": 1,
  "geoDateTime": "Hello, world!",
  "createDateTime": "Hello, world!",
  "updateDateTime": "Hello, world!",
  "admin1Code": "Hello, world!",
  "admin1GeoId": 1,
  "admin1Name": "Hello, world!",
  "admin2Code": "Hello, world!",
  "admin2GeoId": 1,
  "admin2Name": "Hello, world!",
  "admin3Code": "Hello, world!",
  "admin3GeoId": 1,
  "admin3Name": "Hello, world!",
  "admin4Code": "Hello, world!",
  "admin4GeoId": 1,
  "admin4Name": "Hello, world!",
  "admin5Code": "Hello, world!",
  "admin5GeoId": 1,
  "admin5Name": "Hello, world!",
  "zone1GeoId": 1,
  "zone2GeoId": 1,
  "zone3GeoId": 1,
  "zone4GeoId": 1,
  "zone5GeoId": 1,
  "zone1": "Hello, world!",
  "zone2": "Hello, world!",
  "zone3": "Hello, world!",
  "zone3Name": "Hello, world!",
  "zone4Name": "Hello, world!",
  "zone5Name": "Hello, world!",
  "zone3Code": "Hello, world!",
  "zone4Code": "Hello, world!",
  "zone5Code": "Hello, world!",
  "ugid": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "addressId": {
      "type": "number"
    },
    "area": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "buildingId": {
      "type": "string"
    },
    "buildingName": {
      "type": "string"
    },
    "addressType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "country": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "countryScheme": {
      "type": "string"
    },
    "countryGeoId": {
      "type": "number"
    },
    "countryRmsCode": {
      "type": "string"
    },
    "latitude": {
      "type": "number"
    },
    "longitude": {
      "type": "number"
    },
    "addressText": {
      "type": "string"
    },
    "streetAddress": {
      "type": "string"
    },
    "cityCode": {
      "type": "string"
    },
    "cityName": {
      "type": "string"
    },
    "cityGeoId": {
      "type": "number"
    },
    "postalCode": {
      "type": "string"
    },
    "postalGeoId": {
      "type": "number"
    },
    "block": {
      "type": "string"
    },
    "blockGroup": {
      "type": "string"
    },
    "locationCode": {
      "type": "string"
    },
    "locationCodeGeoId": {
      "type": "number"
    },
    "parcelNumber": {
      "type": "string"
    },
    "subLocality": {
      "type": "string"
    },
    "geoResolutionConfidence": {
      "type": "number"
    },
    "geoAccuracyBuffer": {
      "type": "number"
    },
    "geoProductVersion": {
      "type": "string"
    },
    "geoLocationCode": {
      "type": "string"
    },
    "geoMatchCode": {
      "type": "string"
    },
    "geoDataSourceId": {
      "type": "number"
    },
    "geoResolutionCode": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "geoDataSourceVersionId": {
      "type": "number"
    },
    "geoDateTime": {
      "type": "string"
    },
    "createDateTime": {
      "type": "string"
    },
    "updateDateTime": {
      "type": "string"
    },
    "admin1Code": {
      "type": "string"
    },
    "admin1GeoId": {
      "type": "number"
    },
    "admin1Name": {
      "type": "string"
    },
    "admin2Code": {
      "type": "string"
    },
    "admin2GeoId": {
      "type": "number"
    },
    "admin2Name": {
      "type": "string"
    },
    "admin3Code": {
      "type": "string"
    },
    "admin3GeoId": {
      "type": "number"
    },
    "admin3Name": {
      "type": "string"
    },
    "admin4Code": {
      "type": "string"
    },
    "admin4GeoId": {
      "type": "number"
    },
    "admin4Name": {
      "type": "string"
    },
    "admin5Code": {
      "type": "string"
    },
    "admin5GeoId": {
      "type": "number"
    },
    "admin5Name": {
      "type": "string"
    },
    "zone1GeoId": {
      "type": "number"
    },
    "zone2GeoId": {
      "type": "number"
    },
    "zone3GeoId": {
      "type": "number"
    },
    "zone4GeoId": {
      "type": "number"
    },
    "zone5GeoId": {
      "type": "number"
    },
    "zone1": {
      "type": "string"
    },
    "zone2": {
      "type": "string"
    },
    "zone3": {
      "type": "string"
    },
    "zone3Name": {
      "type": "string"
    },
    "zone4Name": {
      "type": "string"
    },
    "zone5Name": {
      "type": "string"
    },
    "zone3Code": {
      "type": "string"
    },
    "zone4Code": {
      "type": "string"
    },
    "zone5Code": {
      "type": "string"
    },
    "ugid": {
      "type": "string"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Hazard By Id

runHazardLI
PUT/locations/{id}/hazard{?datasource,profiles}

Hazard single location by location Id

Example URI

PUT /api/v1/locations/id/hazard?datasource=&profiles=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (optional) 

Name of the data source.

profiles
string (required) 
Response  201
HideShow

OK. Hazard report for the given location generated successfully

Headers
Content-Type: application/json
Body
{
  "errorReport": [
    "Hello, world!"
  ],
  "htmlReportOutput": "Hello, world!",
  "apZoneReport": {
    "apZone": "Hello, world!",
    "apZoneConfidenceMsg": "Hello, world!",
    "apZoneError": "Hello, world!",
    "apResolutionCode": 1
  },
  "distanceToFaultReport": {
    "nearestFaults": [
      {
        "faultName": "Hello, world!",
        "faultType": "Hello, world!",
        "faultDistance": {
          "unit": "Hello, world!",
          "value": 1
        },
        "parentID": 1,
        "faultMagnitude600": {
          "unit": "Hello, world!",
          "value": 1
        },
        "faultMagnitude650": {
          "unit": "Hello, world!",
          "value": 1
        },
        "faultMagnitude700": {
          "unit": "Hello, world!",
          "value": 1
        },
        "faultMagnitude750": {
          "unit": "Hello, world!",
          "value": 1
        }
      }
    ],
    "nearestBackgrounds": [
      {
        "faultMagnitude600": {
          "unit": "Hello, world!",
          "value": 1
        },
        "faultMagnitude650": {
          "unit": "Hello, world!",
          "value": 1
        },
        "faultMagnitude700": {
          "unit": "Hello, world!",
          "value": 1
        },
        "faultMagnitude750": {
          "unit": "Hello, world!",
          "value": 1
        }
      }
    ],
    "distanceToFaultError": "Hello, world!"
  },
  "landslideReport": {
    "landslideValue": 1,
    "landslideDescription": "Hello, world!",
    "landslideConfidenceMsg": "Hello, world!",
    "landslideOtherTypes": "Hello, world!",
    "landslideDataResolution": "Hello, world!",
    "landslideError": "Hello, world!",
    "resolutionCode": 1,
    "covariance": 1,
    "hdLandslideMatch": 1,
    "cv": 1
  },
  "liquefactionReport": {
    "liquefactionValue": 1,
    "liquefactionDescription": "Hello, world!",
    "liquefactionConfidenceMsg": "Hello, world!",
    "liquefactionOtherTypes": "Hello, world!",
    "liquefactionDataResolution": "Hello, world!",
    "liquefactionError": "Hello, world!",
    "resolutionCode": 1,
    "covariance": 1,
    "hdLiquefactionMatch": 1,
    "cv": 1
  },
  "mmiReport": {
    "mmi100": 1,
    "mmi200": 1,
    "mmi250": 1,
    "mmi475": 1,
    "mmiDataResolution": "Hello, world!",
    "mmiError": "Hello, world!",
    "resolutionCode": 1
  },
  "eqRiskProfileReport": {
    "eqRiskProfileR1": 1,
    "eqRiskProfileR2": 1,
    "eqRiskProfileR5": 1,
    "eqRiskProfileRRCounty": 1,
    "eqRiskProfileRRState": 1,
    "eqRiskProfileDataResolution": "Hello, world!",
    "eqRiskProfileError": "Hello, world!"
  },
  "eqRiskScoreReport": {
    "eqRiskScore": "Hello, world!",
    "eqRiskScoreDataResolution": "Hello, world!",
    "eqRiskScoreError": "Hello, world!"
  },
  "slopeReport": {
    "slopeAverage": {
      "unit": "Hello, world!",
      "value": 1
    },
    "slopeMin": {
      "unit": "Hello, world!",
      "value": 1
    },
    "slopeMax": {
      "unit": "Hello, world!",
      "value": 1
    },
    "slopeBearingToMin": "Hello, world!",
    "slopeBearingToMax": "Hello, world!",
    "slopeConfidence": "Hello, world!",
    "slopeError": "Hello, world!"
  },
  "soilReport": {
    "soilValue": 1,
    "soilConfidence": 1,
    "soilDescription": "Hello, world!",
    "soilConfidenceMsg": "Hello, world!",
    "soilOtherTypes": "Hello, world!",
    "soilDataResolution": "Hello, world!",
    "soilError": "Hello, world!"
  },
  "distanceToCoastReport": {
    "distanceToCoast": {
      "unit": "Hello, world!",
      "value": 1
    },
    "distanceToCoastDataResolution": "Hello, world!",
    "distanceToCoastError": "Hello, world!"
  },
  "elevationReport": {
    "elevationAverage": {
      "unit": "Hello, world!",
      "value": 1
    },
    "elevationDataResolution": "Hello, world!",
    "elevationError": "Hello, world!"
  },
  "huRiskProfileReport": {
    "huRiskProfileR1": 1,
    "huRiskProfileR2": 1,
    "huRiskProfileR5": 1,
    "huRiskProfileRRCounty": 1,
    "huRiskProfileRRState": 1,
    "huRiskProfileDataResolution": "Hello, world!",
    "huRiskProfileError": "Hello, world!"
  },
  "huRiskScoreReport": {
    "huRiskScore": "Hello, world!",
    "huRiskScoreDataResolution": "Hello, world!",
    "huRiskScoreError": "Hello, world!"
  },
  "windpoolReport": {
    "windpoolZone": "Hello, world!",
    "windpoolType": "Hello, world!",
    "windpoolError": "Hello, world!",
    "windpoolConfidenceArea": "Hello, world!"
  },
  "floodReport": {
    "floodAnswerType": "Hello, world!",
    "floodMapSource": "Hello, world!",
    "floodZone": "Hello, world!",
    "floodDescription": "Hello, world!",
    "floodAnnualProbability": "Hello, world!",
    "floodConfidence": 1,
    "floodConfidenceMsg": "Hello, world!",
    "floodBuffer": {
      "unit": "Hello, world!",
      "value": 1
    },
    "floodOtherZones": "Hello, world!",
    "floodBFE": {
      "unit": "Hello, world!",
      "value": 1
    },
    "floodAdditionalInfo": "Hello, world!",
    "floodPanel": "Hello, world!",
    "floodPanelDate": "Hello, world!",
    "floodPanelRevision": "Hello, world!",
    "floodCOBRA": "Hello, world!",
    "floodWay": "Hello, world!",
    "floodSFHA": "Hello, world!",
    "floodCommunity": "Hello, world!",
    "floodError": "Hello, world!"
  },
  "wildfireReport": {
    "wildfireHazard": 1,
    "wildfireHazardDescription": "Hello, world!",
    "wildfireSusceptibility": 1,
    "wildfireSusceptibilityDescription": "Hello, world!",
    "wildfireThreat": 1,
    "wildfireThreatDescription": "Hello, world!",
    "wildfireAreaDescription": "Hello, world!",
    "wildfireFuelType": "Hello, world!",
    "wildfireFuelTypeDescription": "Hello, world!",
    "wildfireSpecialConditions": "Hello, world!",
    "wildfireHistoricalLocalFireAvg": 1,
    "wildfireHistoricalNearbyFireAvg": 1,
    "wildfireAccessibility": 1,
    "wildfireAccessibilityDescription": "Hello, world!",
    "wildfireDataResolution": "Hello, world!",
    "wildfireError": "Hello, world!"
  },
  "scsRiskProfileReport": {
    "scsRiskProfileR20": 1,
    "scsRiskProfileR50": 1,
    "scsRiskProfileR100": 1,
    "scsRiskProfileR250": 1,
    "scsDominantPerilR20": "Hello, world!",
    "scsDominantPerilR50": "Hello, world!",
    "scsDominantPerilR100": "Hello, world!",
    "scsDominantPerilR250": "Hello, world!",
    "scsRiskProfileRRCounty": 1,
    "scsRiskProfileRRState": 1,
    "scsRiskProfileDataResolution": "Hello, world!",
    "scsRiskProfileError": "Hello, world!"
  },
  "scsRiskScoreReport": {
    "scsRiskScore": "Hello, world!",
    "scsDominantPeril": "Hello, world!",
    "scsRiskScoreDataResolution": "Hello, world!",
    "scsRiskScoreError": "Hello, world!"
  },
  "subsidenceReport": {
    "sinkholeHazardReport": {
      "sinkholeClass": 1,
      "sinkholeDescription": "Hello, world!",
      "sinkholeConfidenceMsg": "Hello, world!",
      "sinkholeOtherTypes": "Hello, world!",
      "sinkholeDataResolution": "Hello, world!",
      "sinkholeBuffer": {
        "unit": "Hello, world!",
        "value": 1
      },
      "sinkholeError": "Hello, world!"
    },
    "distanceToSinkholeReport": {
      "nearestSinkholes": [
        {
          "sinkhole": 1,
          "sinkholeDistance": {
            "unit": "Hello, world!",
            "value": 1
          },
          "sinkholeArea": 1
        }
      ],
      "d2SinkholesDataResolution": "Hello, world!",
      "d2SinkholesBuffer": {
        "unit": "Hello, world!",
        "value": 1
      },
      "distanceToSinkholeError": "Hello, world!"
    },
    "distanceToMineReport": {
      "nearestMines": [
        {
          "mine": 1,
          "mineDistance": {
            "unit": "Hello, world!",
            "value": 1
          },
          "mineName": "Hello, world!",
          "mineType": "Hello, world!",
          "mineArea": 1,
          "status": "Hello, world!"
        }
      ],
      "d2MinesDataResolution": "Hello, world!",
      "d2MinesBuffer": {
        "unit": "Hello, world!",
        "value": 1
      },
      "distanceToMinesError": "Hello, world!"
    },
    "subsidenceReportError": "Hello, world!"
  },
  "stormSurgeReport": {
    "ss100": "Hello, world!",
    "ss250": "Hello, world!",
    "ss500": "Hello, world!",
    "ss1000": "Hello, world!",
    "stormsurgeDataResolution": "Hello, world!",
    "stormsurgeError": "Hello, world!"
  },
  "windRatingScoreReport": {
    "territoryID": 1,
    "territoryCountyCode": "Hello, world!",
    "aopId": 1,
    "wrs": 1,
    "relativityFactor": 1,
    "getnWRT": 1,
    "windRatingScoreDataResolution": "Hello, world!",
    "windRatingScoreError": "Hello, world!"
  },
  "hdFloodReport": {
    "fl100YrDef": "Hello, world!",
    "fl100YrUndef": "Hello, world!",
    "fl250YrDef": "Hello, world!",
    "fl250YrUnef": "Hello, world!",
    "fl500YrDef": "Hello, world!",
    "fl500YrUndef": "Hello, world!",
    "basinName": "Hello, world!",
    "catchmentId": 1,
    "rms100YrFlZone": "Hello, world!",
    "rms500YrFlZone": "Hello, world!",
    "hdFloodDataResolution": "Hello, world!",
    "hdFloodError": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errorReport": {
      "type": "array"
    },
    "htmlReportOutput": {
      "type": "string"
    },
    "apZoneReport": {
      "type": "object",
      "properties": {
        "apZone": {
          "type": "string"
        },
        "apZoneConfidenceMsg": {
          "type": "string"
        },
        "apZoneError": {
          "type": "string"
        },
        "apResolutionCode": {
          "type": "number"
        }
      }
    },
    "distanceToFaultReport": {
      "type": "object",
      "properties": {
        "nearestFaults": {
          "type": "array"
        },
        "nearestBackgrounds": {
          "type": "array"
        },
        "distanceToFaultError": {
          "type": "string"
        }
      }
    },
    "landslideReport": {
      "type": "object",
      "properties": {
        "landslideValue": {
          "type": "number"
        },
        "landslideDescription": {
          "type": "string"
        },
        "landslideConfidenceMsg": {
          "type": "string"
        },
        "landslideOtherTypes": {
          "type": "string"
        },
        "landslideDataResolution": {
          "type": "string"
        },
        "landslideError": {
          "type": "string"
        },
        "resolutionCode": {
          "type": "number"
        },
        "covariance": {
          "type": "number"
        },
        "hdLandslideMatch": {
          "type": "number"
        },
        "cv": {
          "type": "number"
        }
      }
    },
    "liquefactionReport": {
      "type": "object",
      "properties": {
        "liquefactionValue": {
          "type": "number"
        },
        "liquefactionDescription": {
          "type": "string"
        },
        "liquefactionConfidenceMsg": {
          "type": "string"
        },
        "liquefactionOtherTypes": {
          "type": "string"
        },
        "liquefactionDataResolution": {
          "type": "string"
        },
        "liquefactionError": {
          "type": "string"
        },
        "resolutionCode": {
          "type": "number"
        },
        "covariance": {
          "type": "number"
        },
        "hdLiquefactionMatch": {
          "type": "number"
        },
        "cv": {
          "type": "number"
        }
      }
    },
    "mmiReport": {
      "type": "object",
      "properties": {
        "mmi100": {
          "type": "number"
        },
        "mmi200": {
          "type": "number"
        },
        "mmi250": {
          "type": "number"
        },
        "mmi475": {
          "type": "number"
        },
        "mmiDataResolution": {
          "type": "string"
        },
        "mmiError": {
          "type": "string"
        },
        "resolutionCode": {
          "type": "number"
        }
      }
    },
    "eqRiskProfileReport": {
      "type": "object",
      "properties": {
        "eqRiskProfileR1": {
          "type": "number"
        },
        "eqRiskProfileR2": {
          "type": "number"
        },
        "eqRiskProfileR5": {
          "type": "number"
        },
        "eqRiskProfileRRCounty": {
          "type": "number"
        },
        "eqRiskProfileRRState": {
          "type": "number"
        },
        "eqRiskProfileDataResolution": {
          "type": "string"
        },
        "eqRiskProfileError": {
          "type": "string"
        }
      }
    },
    "eqRiskScoreReport": {
      "type": "object",
      "properties": {
        "eqRiskScore": {
          "type": "string"
        },
        "eqRiskScoreDataResolution": {
          "type": "string"
        },
        "eqRiskScoreError": {
          "type": "string"
        }
      }
    },
    "slopeReport": {
      "type": "object",
      "properties": {
        "slopeAverage": {
          "type": "object",
          "properties": {
            "unit": {
              "type": "string"
            },
            "value": {
              "type": "number"
            }
          }
        },
        "slopeMin": {
          "type": "object",
          "properties": {
            "unit": {
              "type": "string"
            },
            "value": {
              "type": "number"
            }
          }
        },
        "slopeMax": {
          "type": "object",
          "properties": {
            "unit": {
              "type": "string"
            },
            "value": {
              "type": "number"
            }
          }
        },
        "slopeBearingToMin": {
          "type": "string"
        },
        "slopeBearingToMax": {
          "type": "string"
        },
        "slopeConfidence": {
          "type": "string"
        },
        "slopeError": {
          "type": "string"
        }
      }
    },
    "soilReport": {
      "type": "object",
      "properties": {
        "soilValue": {
          "type": "number"
        },
        "soilConfidence": {
          "type": "number"
        },
        "soilDescription": {
          "type": "string"
        },
        "soilConfidenceMsg": {
          "type": "string"
        },
        "soilOtherTypes": {
          "type": "string"
        },
        "soilDataResolution": {
          "type": "string"
        },
        "soilError": {
          "type": "string"
        }
      }
    },
    "distanceToCoastReport": {
      "type": "object",
      "properties": {
        "distanceToCoast": {
          "type": "object",
          "properties": {
            "unit": {
              "type": "string"
            },
            "value": {
              "type": "number"
            }
          }
        },
        "distanceToCoastDataResolution": {
          "type": "string"
        },
        "distanceToCoastError": {
          "type": "string"
        }
      }
    },
    "elevationReport": {
      "type": "object",
      "properties": {
        "elevationAverage": {
          "type": "object",
          "properties": {
            "unit": {
              "type": "string"
            },
            "value": {
              "type": "number"
            }
          }
        },
        "elevationDataResolution": {
          "type": "string"
        },
        "elevationError": {
          "type": "string"
        }
      }
    },
    "huRiskProfileReport": {
      "type": "object",
      "properties": {
        "huRiskProfileR1": {
          "type": "number"
        },
        "huRiskProfileR2": {
          "type": "number"
        },
        "huRiskProfileR5": {
          "type": "number"
        },
        "huRiskProfileRRCounty": {
          "type": "number"
        },
        "huRiskProfileRRState": {
          "type": "number"
        },
        "huRiskProfileDataResolution": {
          "type": "string"
        },
        "huRiskProfileError": {
          "type": "string"
        }
      }
    },
    "huRiskScoreReport": {
      "type": "object",
      "properties": {
        "huRiskScore": {
          "type": "string"
        },
        "huRiskScoreDataResolution": {
          "type": "string"
        },
        "huRiskScoreError": {
          "type": "string"
        }
      }
    },
    "windpoolReport": {
      "type": "object",
      "properties": {
        "windpoolZone": {
          "type": "string"
        },
        "windpoolType": {
          "type": "string"
        },
        "windpoolError": {
          "type": "string"
        },
        "windpoolConfidenceArea": {
          "type": "string"
        }
      }
    },
    "floodReport": {
      "type": "object",
      "properties": {
        "floodAnswerType": {
          "type": "string"
        },
        "floodMapSource": {
          "type": "string"
        },
        "floodZone": {
          "type": "string"
        },
        "floodDescription": {
          "type": "string"
        },
        "floodAnnualProbability": {
          "type": "string"
        },
        "floodConfidence": {
          "type": "number"
        },
        "floodConfidenceMsg": {
          "type": "string"
        },
        "floodBuffer": {
          "type": "object",
          "properties": {
            "unit": {
              "type": "string"
            },
            "value": {
              "type": "number"
            }
          }
        },
        "floodOtherZones": {
          "type": "string"
        },
        "floodBFE": {
          "type": "object",
          "properties": {
            "unit": {
              "type": "string"
            },
            "value": {
              "type": "number"
            }
          }
        },
        "floodAdditionalInfo": {
          "type": "string"
        },
        "floodPanel": {
          "type": "string"
        },
        "floodPanelDate": {
          "type": "string"
        },
        "floodPanelRevision": {
          "type": "string"
        },
        "floodCOBRA": {
          "type": "string"
        },
        "floodWay": {
          "type": "string"
        },
        "floodSFHA": {
          "type": "string"
        },
        "floodCommunity": {
          "type": "string"
        },
        "floodError": {
          "type": "string"
        }
      }
    },
    "wildfireReport": {
      "type": "object",
      "properties": {
        "wildfireHazard": {
          "type": "number"
        },
        "wildfireHazardDescription": {
          "type": "string"
        },
        "wildfireSusceptibility": {
          "type": "number"
        },
        "wildfireSusceptibilityDescription": {
          "type": "string"
        },
        "wildfireThreat": {
          "type": "number"
        },
        "wildfireThreatDescription": {
          "type": "string"
        },
        "wildfireAreaDescription": {
          "type": "string"
        },
        "wildfireFuelType": {
          "type": "string"
        },
        "wildfireFuelTypeDescription": {
          "type": "string"
        },
        "wildfireSpecialConditions": {
          "type": "string"
        },
        "wildfireHistoricalLocalFireAvg": {
          "type": "number"
        },
        "wildfireHistoricalNearbyFireAvg": {
          "type": "number"
        },
        "wildfireAccessibility": {
          "type": "number"
        },
        "wildfireAccessibilityDescription": {
          "type": "string"
        },
        "wildfireDataResolution": {
          "type": "string"
        },
        "wildfireError": {
          "type": "string"
        }
      }
    },
    "scsRiskProfileReport": {
      "type": "object",
      "properties": {
        "scsRiskProfileR20": {
          "type": "number"
        },
        "scsRiskProfileR50": {
          "type": "number"
        },
        "scsRiskProfileR100": {
          "type": "number"
        },
        "scsRiskProfileR250": {
          "type": "number"
        },
        "scsDominantPerilR20": {
          "type": "string"
        },
        "scsDominantPerilR50": {
          "type": "string"
        },
        "scsDominantPerilR100": {
          "type": "string"
        },
        "scsDominantPerilR250": {
          "type": "string"
        },
        "scsRiskProfileRRCounty": {
          "type": "number"
        },
        "scsRiskProfileRRState": {
          "type": "number"
        },
        "scsRiskProfileDataResolution": {
          "type": "string"
        },
        "scsRiskProfileError": {
          "type": "string"
        }
      }
    },
    "scsRiskScoreReport": {
      "type": "object",
      "properties": {
        "scsRiskScore": {
          "type": "string"
        },
        "scsDominantPeril": {
          "type": "string"
        },
        "scsRiskScoreDataResolution": {
          "type": "string"
        },
        "scsRiskScoreError": {
          "type": "string"
        }
      }
    },
    "subsidenceReport": {
      "type": "object",
      "properties": {
        "sinkholeHazardReport": {
          "type": "object",
          "properties": {
            "sinkholeClass": {
              "type": "number"
            },
            "sinkholeDescription": {
              "type": "string"
            },
            "sinkholeConfidenceMsg": {
              "type": "string"
            },
            "sinkholeOtherTypes": {
              "type": "string"
            },
            "sinkholeDataResolution": {
              "type": "string"
            },
            "sinkholeBuffer": {
              "type": "object",
              "properties": {
                "unit": {
                  "type": "string"
                },
                "value": {
                  "type": "number"
                }
              }
            },
            "sinkholeError": {
              "type": "string"
            }
          }
        },
        "distanceToSinkholeReport": {
          "type": "object",
          "properties": {
            "nearestSinkholes": {
              "type": "array"
            },
            "d2SinkholesDataResolution": {
              "type": "string"
            },
            "d2SinkholesBuffer": {
              "type": "object",
              "properties": {
                "unit": {
                  "type": "string"
                },
                "value": {
                  "type": "number"
                }
              }
            },
            "distanceToSinkholeError": {
              "type": "string"
            }
          }
        },
        "distanceToMineReport": {
          "type": "object",
          "properties": {
            "nearestMines": {
              "type": "array"
            },
            "d2MinesDataResolution": {
              "type": "string"
            },
            "d2MinesBuffer": {
              "type": "object",
              "properties": {
                "unit": {
                  "type": "string"
                },
                "value": {
                  "type": "number"
                }
              }
            },
            "distanceToMinesError": {
              "type": "string"
            }
          }
        },
        "subsidenceReportError": {
          "type": "string"
        }
      }
    },
    "stormSurgeReport": {
      "type": "object",
      "properties": {
        "ss100": {
          "type": "string"
        },
        "ss250": {
          "type": "string"
        },
        "ss500": {
          "type": "string"
        },
        "ss1000": {
          "type": "string"
        },
        "stormsurgeDataResolution": {
          "type": "string"
        },
        "stormsurgeError": {
          "type": "string"
        }
      }
    },
    "windRatingScoreReport": {
      "type": "object",
      "properties": {
        "territoryID": {
          "type": "number"
        },
        "territoryCountyCode": {
          "type": "string"
        },
        "aopId": {
          "type": "number"
        },
        "wrs": {
          "type": "number"
        },
        "relativityFactor": {
          "type": "number"
        },
        "getnWRT": {
          "type": "number"
        },
        "windRatingScoreDataResolution": {
          "type": "string"
        },
        "windRatingScoreError": {
          "type": "string"
        }
      }
    },
    "hdFloodReport": {
      "type": "object",
      "properties": {
        "fl100YrDef": {
          "type": "string"
        },
        "fl100YrUndef": {
          "type": "string"
        },
        "fl250YrDef": {
          "type": "string"
        },
        "fl250YrUnef": {
          "type": "string"
        },
        "fl500YrDef": {
          "type": "string"
        },
        "fl500YrUndef": {
          "type": "string"
        },
        "basinName": {
          "type": "string"
        },
        "catchmentId": {
          "type": "number"
        },
        "rms100YrFlZone": {
          "type": "string"
        },
        "rms500YrFlZone": {
          "type": "string"
        },
        "hdFloodDataResolution": {
          "type": "string"
        },
        "hdFloodError": {
          "type": "string"
        }
      }
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Hazard Output

runHazardOnTheFly
POST/locations/hazard/output{?profiles}

Executes hazard engine and returns output for the services selected.

Example URI

POST /api/v1/locations/hazard/output?profiles=
URI Parameters
HideShow
profiles
string (required) 

Pass user services or profiles (comma-delimited) for running hazard on the given input.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "propertyReference": "Hello, world!",
  "address": {
    "addressId": 1,
    "area": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "buildingId": "Hello, world!",
    "buildingName": "Hello, world!",
    "addressType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "country": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "countryScheme": "Hello, world!",
    "countryGeoId": 1,
    "countryRmsCode": "Hello, world!",
    "latitude": 1,
    "longitude": 1,
    "addressText": "Hello, world!",
    "streetAddress": "Hello, world!",
    "cityCode": "Hello, world!",
    "cityName": "Hello, world!",
    "cityGeoId": 1,
    "postalCode": "Hello, world!",
    "postalGeoId": 1,
    "block": "Hello, world!",
    "blockGroup": "Hello, world!",
    "locationCode": "Hello, world!",
    "locationCodeGeoId": 1,
    "parcelNumber": "Hello, world!",
    "subLocality": "Hello, world!",
    "geoResolutionConfidence": 1,
    "geoAccuracyBuffer": 1,
    "geoProductVersion": "Hello, world!",
    "geoLocationCode": "Hello, world!",
    "geoMatchCode": "Hello, world!",
    "geoDataSourceId": 1,
    "geoResolutionCode": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "geoDataSourceVersionId": 1,
    "geoDateTime": "Hello, world!",
    "createDateTime": "Hello, world!",
    "updateDateTime": "Hello, world!",
    "admin1Code": "Hello, world!",
    "admin1GeoId": 1,
    "admin1Name": "Hello, world!",
    "admin2Code": "Hello, world!",
    "admin2GeoId": 1,
    "admin2Name": "Hello, world!",
    "admin3Code": "Hello, world!",
    "admin3GeoId": 1,
    "admin3Name": "Hello, world!",
    "admin4Code": "Hello, world!",
    "admin4GeoId": 1,
    "admin4Name": "Hello, world!",
    "admin5Code": "Hello, world!",
    "admin5GeoId": 1,
    "admin5Name": "Hello, world!",
    "zone1GeoId": 1,
    "zone2GeoId": 1,
    "zone3GeoId": 1,
    "zone4GeoId": 1,
    "zone5GeoId": 1,
    "zone1": "Hello, world!",
    "zone2": "Hello, world!",
    "zone3": "Hello, world!",
    "zone3Name": "Hello, world!",
    "zone4Name": "Hello, world!",
    "zone5Name": "Hello, world!",
    "zone3Code": "Hello, world!",
    "zone4Code": "Hello, world!",
    "zone5Code": "Hello, world!",
    "ugid": "Hello, world!"
  },
  "buildingInfo": {
    "country": "Hello, world!",
    "postalCode": "Hello, world!",
    "buildingClassScheme": "Hello, world!",
    "buildingClass": "Hello, world!",
    "occupancyTypeScheme": "Hello, world!",
    "occupancyType": 1,
    "stories": 1,
    "yearBuilt": "Hello, world!",
    "floorArea": 1,
    "areaUnit": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "bldgValuation": 1,
    "datasource": "Hello, world!",
    "cntryScheme": "Hello, world!",
    "cntryCode": "Hello, world!",
    "streetAddress": "Hello, world!",
    "city": "Hello, world!",
    "state": "Hello, world!",
    "valuationName": "Hello, world!",
    "buildingType": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "propertyReference": {
      "type": "string"
    },
    "address": {
      "type": "object",
      "properties": {
        "addressId": {
          "type": "number"
        },
        "area": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "buildingId": {
          "type": "string"
        },
        "buildingName": {
          "type": "string"
        },
        "addressType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "country": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "countryScheme": {
          "type": "string"
        },
        "countryGeoId": {
          "type": "number"
        },
        "countryRmsCode": {
          "type": "string"
        },
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        },
        "addressText": {
          "type": "string"
        },
        "streetAddress": {
          "type": "string"
        },
        "cityCode": {
          "type": "string"
        },
        "cityName": {
          "type": "string"
        },
        "cityGeoId": {
          "type": "number"
        },
        "postalCode": {
          "type": "string"
        },
        "postalGeoId": {
          "type": "number"
        },
        "block": {
          "type": "string"
        },
        "blockGroup": {
          "type": "string"
        },
        "locationCode": {
          "type": "string"
        },
        "locationCodeGeoId": {
          "type": "number"
        },
        "parcelNumber": {
          "type": "string"
        },
        "subLocality": {
          "type": "string"
        },
        "geoResolutionConfidence": {
          "type": "number"
        },
        "geoAccuracyBuffer": {
          "type": "number"
        },
        "geoProductVersion": {
          "type": "string"
        },
        "geoLocationCode": {
          "type": "string"
        },
        "geoMatchCode": {
          "type": "string"
        },
        "geoDataSourceId": {
          "type": "number"
        },
        "geoResolutionCode": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "geoDataSourceVersionId": {
          "type": "number"
        },
        "geoDateTime": {
          "type": "string"
        },
        "createDateTime": {
          "type": "string"
        },
        "updateDateTime": {
          "type": "string"
        },
        "admin1Code": {
          "type": "string"
        },
        "admin1GeoId": {
          "type": "number"
        },
        "admin1Name": {
          "type": "string"
        },
        "admin2Code": {
          "type": "string"
        },
        "admin2GeoId": {
          "type": "number"
        },
        "admin2Name": {
          "type": "string"
        },
        "admin3Code": {
          "type": "string"
        },
        "admin3GeoId": {
          "type": "number"
        },
        "admin3Name": {
          "type": "string"
        },
        "admin4Code": {
          "type": "string"
        },
        "admin4GeoId": {
          "type": "number"
        },
        "admin4Name": {
          "type": "string"
        },
        "admin5Code": {
          "type": "string"
        },
        "admin5GeoId": {
          "type": "number"
        },
        "admin5Name": {
          "type": "string"
        },
        "zone1GeoId": {
          "type": "number"
        },
        "zone2GeoId": {
          "type": "number"
        },
        "zone3GeoId": {
          "type": "number"
        },
        "zone4GeoId": {
          "type": "number"
        },
        "zone5GeoId": {
          "type": "number"
        },
        "zone1": {
          "type": "string"
        },
        "zone2": {
          "type": "string"
        },
        "zone3": {
          "type": "string"
        },
        "zone3Name": {
          "type": "string"
        },
        "zone4Name": {
          "type": "string"
        },
        "zone5Name": {
          "type": "string"
        },
        "zone3Code": {
          "type": "string"
        },
        "zone4Code": {
          "type": "string"
        },
        "zone5Code": {
          "type": "string"
        },
        "ugid": {
          "type": "string"
        }
      }
    },
    "buildingInfo": {
      "type": "object",
      "properties": {
        "country": {
          "type": "string"
        },
        "postalCode": {
          "type": "string"
        },
        "buildingClassScheme": {
          "type": "string"
        },
        "buildingClass": {
          "type": "string"
        },
        "occupancyTypeScheme": {
          "type": "string"
        },
        "occupancyType": {
          "type": "number"
        },
        "stories": {
          "type": "number"
        },
        "yearBuilt": {
          "type": "string"
        },
        "floorArea": {
          "type": "number"
        },
        "areaUnit": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "bldgValuation": {
          "type": "number"
        },
        "datasource": {
          "type": "string"
        },
        "cntryScheme": {
          "type": "string"
        },
        "cntryCode": {
          "type": "string"
        },
        "streetAddress": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "valuationName": {
          "type": "string"
        },
        "buildingType": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "address",
    "buildingInfo"
  ]
}
Response  201
HideShow

OK. Hazard is successfully run.

Headers
Content-Type: application/json
Body
{
  "errorReport": [
    "Hello, world!"
  ],
  "htmlReportOutput": "Hello, world!",
  "apZoneReport": {
    "apZone": "Hello, world!",
    "apZoneConfidenceMsg": "Hello, world!",
    "apZoneError": "Hello, world!",
    "apResolutionCode": 1
  },
  "distanceToFaultReport": {
    "nearestFaults": [
      {
        "faultName": "Hello, world!",
        "faultType": "Hello, world!",
        "faultDistance": {
          "unit": "Hello, world!",
          "value": 1
        },
        "parentID": 1,
        "faultMagnitude600": {
          "unit": "Hello, world!",
          "value": 1
        },
        "faultMagnitude650": {
          "unit": "Hello, world!",
          "value": 1
        },
        "faultMagnitude700": {
          "unit": "Hello, world!",
          "value": 1
        },
        "faultMagnitude750": {
          "unit": "Hello, world!",
          "value": 1
        }
      }
    ],
    "nearestBackgrounds": [
      {
        "faultMagnitude600": {
          "unit": "Hello, world!",
          "value": 1
        },
        "faultMagnitude650": {
          "unit": "Hello, world!",
          "value": 1
        },
        "faultMagnitude700": {
          "unit": "Hello, world!",
          "value": 1
        },
        "faultMagnitude750": {
          "unit": "Hello, world!",
          "value": 1
        }
      }
    ],
    "distanceToFaultError": "Hello, world!"
  },
  "landslideReport": {
    "landslideValue": 1,
    "landslideDescription": "Hello, world!",
    "landslideConfidenceMsg": "Hello, world!",
    "landslideOtherTypes": "Hello, world!",
    "landslideDataResolution": "Hello, world!",
    "landslideError": "Hello, world!",
    "resolutionCode": 1,
    "covariance": 1,
    "hdLandslideMatch": 1,
    "cv": 1
  },
  "liquefactionReport": {
    "liquefactionValue": 1,
    "liquefactionDescription": "Hello, world!",
    "liquefactionConfidenceMsg": "Hello, world!",
    "liquefactionOtherTypes": "Hello, world!",
    "liquefactionDataResolution": "Hello, world!",
    "liquefactionError": "Hello, world!",
    "resolutionCode": 1,
    "covariance": 1,
    "hdLiquefactionMatch": 1,
    "cv": 1
  },
  "mmiReport": {
    "mmi100": 1,
    "mmi200": 1,
    "mmi250": 1,
    "mmi475": 1,
    "mmiDataResolution": "Hello, world!",
    "mmiError": "Hello, world!",
    "resolutionCode": 1
  },
  "eqRiskProfileReport": {
    "eqRiskProfileR1": 1,
    "eqRiskProfileR2": 1,
    "eqRiskProfileR5": 1,
    "eqRiskProfileRRCounty": 1,
    "eqRiskProfileRRState": 1,
    "eqRiskProfileDataResolution": "Hello, world!",
    "eqRiskProfileError": "Hello, world!"
  },
  "eqRiskScoreReport": {
    "eqRiskScore": "Hello, world!",
    "eqRiskScoreDataResolution": "Hello, world!",
    "eqRiskScoreError": "Hello, world!"
  },
  "slopeReport": {
    "slopeAverage": {
      "unit": "Hello, world!",
      "value": 1
    },
    "slopeMin": {
      "unit": "Hello, world!",
      "value": 1
    },
    "slopeMax": {
      "unit": "Hello, world!",
      "value": 1
    },
    "slopeBearingToMin": "Hello, world!",
    "slopeBearingToMax": "Hello, world!",
    "slopeConfidence": "Hello, world!",
    "slopeError": "Hello, world!"
  },
  "soilReport": {
    "soilValue": 1,
    "soilConfidence": 1,
    "soilDescription": "Hello, world!",
    "soilConfidenceMsg": "Hello, world!",
    "soilOtherTypes": "Hello, world!",
    "soilDataResolution": "Hello, world!",
    "soilError": "Hello, world!"
  },
  "distanceToCoastReport": {
    "distanceToCoast": {
      "unit": "Hello, world!",
      "value": 1
    },
    "distanceToCoastDataResolution": "Hello, world!",
    "distanceToCoastError": "Hello, world!"
  },
  "elevationReport": {
    "elevationAverage": {
      "unit": "Hello, world!",
      "value": 1
    },
    "elevationDataResolution": "Hello, world!",
    "elevationError": "Hello, world!"
  },
  "huRiskProfileReport": {
    "huRiskProfileR1": 1,
    "huRiskProfileR2": 1,
    "huRiskProfileR5": 1,
    "huRiskProfileRRCounty": 1,
    "huRiskProfileRRState": 1,
    "huRiskProfileDataResolution": "Hello, world!",
    "huRiskProfileError": "Hello, world!"
  },
  "huRiskScoreReport": {
    "huRiskScore": "Hello, world!",
    "huRiskScoreDataResolution": "Hello, world!",
    "huRiskScoreError": "Hello, world!"
  },
  "windpoolReport": {
    "windpoolZone": "Hello, world!",
    "windpoolType": "Hello, world!",
    "windpoolError": "Hello, world!",
    "windpoolConfidenceArea": "Hello, world!"
  },
  "floodReport": {
    "floodAnswerType": "Hello, world!",
    "floodMapSource": "Hello, world!",
    "floodZone": "Hello, world!",
    "floodDescription": "Hello, world!",
    "floodAnnualProbability": "Hello, world!",
    "floodConfidence": 1,
    "floodConfidenceMsg": "Hello, world!",
    "floodBuffer": {
      "unit": "Hello, world!",
      "value": 1
    },
    "floodOtherZones": "Hello, world!",
    "floodBFE": {
      "unit": "Hello, world!",
      "value": 1
    },
    "floodAdditionalInfo": "Hello, world!",
    "floodPanel": "Hello, world!",
    "floodPanelDate": "Hello, world!",
    "floodPanelRevision": "Hello, world!",
    "floodCOBRA": "Hello, world!",
    "floodWay": "Hello, world!",
    "floodSFHA": "Hello, world!",
    "floodCommunity": "Hello, world!",
    "floodError": "Hello, world!"
  },
  "wildfireReport": {
    "wildfireHazard": 1,
    "wildfireHazardDescription": "Hello, world!",
    "wildfireSusceptibility": 1,
    "wildfireSusceptibilityDescription": "Hello, world!",
    "wildfireThreat": 1,
    "wildfireThreatDescription": "Hello, world!",
    "wildfireAreaDescription": "Hello, world!",
    "wildfireFuelType": "Hello, world!",
    "wildfireFuelTypeDescription": "Hello, world!",
    "wildfireSpecialConditions": "Hello, world!",
    "wildfireHistoricalLocalFireAvg": 1,
    "wildfireHistoricalNearbyFireAvg": 1,
    "wildfireAccessibility": 1,
    "wildfireAccessibilityDescription": "Hello, world!",
    "wildfireDataResolution": "Hello, world!",
    "wildfireError": "Hello, world!"
  },
  "scsRiskProfileReport": {
    "scsRiskProfileR20": 1,
    "scsRiskProfileR50": 1,
    "scsRiskProfileR100": 1,
    "scsRiskProfileR250": 1,
    "scsDominantPerilR20": "Hello, world!",
    "scsDominantPerilR50": "Hello, world!",
    "scsDominantPerilR100": "Hello, world!",
    "scsDominantPerilR250": "Hello, world!",
    "scsRiskProfileRRCounty": 1,
    "scsRiskProfileRRState": 1,
    "scsRiskProfileDataResolution": "Hello, world!",
    "scsRiskProfileError": "Hello, world!"
  },
  "scsRiskScoreReport": {
    "scsRiskScore": "Hello, world!",
    "scsDominantPeril": "Hello, world!",
    "scsRiskScoreDataResolution": "Hello, world!",
    "scsRiskScoreError": "Hello, world!"
  },
  "subsidenceReport": {
    "sinkholeHazardReport": {
      "sinkholeClass": 1,
      "sinkholeDescription": "Hello, world!",
      "sinkholeConfidenceMsg": "Hello, world!",
      "sinkholeOtherTypes": "Hello, world!",
      "sinkholeDataResolution": "Hello, world!",
      "sinkholeBuffer": {
        "unit": "Hello, world!",
        "value": 1
      },
      "sinkholeError": "Hello, world!"
    },
    "distanceToSinkholeReport": {
      "nearestSinkholes": [
        {
          "sinkhole": 1,
          "sinkholeDistance": {
            "unit": "Hello, world!",
            "value": 1
          },
          "sinkholeArea": 1
        }
      ],
      "d2SinkholesDataResolution": "Hello, world!",
      "d2SinkholesBuffer": {
        "unit": "Hello, world!",
        "value": 1
      },
      "distanceToSinkholeError": "Hello, world!"
    },
    "distanceToMineReport": {
      "nearestMines": [
        {
          "mine": 1,
          "mineDistance": {
            "unit": "Hello, world!",
            "value": 1
          },
          "mineName": "Hello, world!",
          "mineType": "Hello, world!",
          "mineArea": 1,
          "status": "Hello, world!"
        }
      ],
      "d2MinesDataResolution": "Hello, world!",
      "d2MinesBuffer": {
        "unit": "Hello, world!",
        "value": 1
      },
      "distanceToMinesError": "Hello, world!"
    },
    "subsidenceReportError": "Hello, world!"
  },
  "stormSurgeReport": {
    "ss100": "Hello, world!",
    "ss250": "Hello, world!",
    "ss500": "Hello, world!",
    "ss1000": "Hello, world!",
    "stormsurgeDataResolution": "Hello, world!",
    "stormsurgeError": "Hello, world!"
  },
  "windRatingScoreReport": {
    "territoryID": 1,
    "territoryCountyCode": "Hello, world!",
    "aopId": 1,
    "wrs": 1,
    "relativityFactor": 1,
    "getnWRT": 1,
    "windRatingScoreDataResolution": "Hello, world!",
    "windRatingScoreError": "Hello, world!"
  },
  "hdFloodReport": {
    "fl100YrDef": "Hello, world!",
    "fl100YrUndef": "Hello, world!",
    "fl250YrDef": "Hello, world!",
    "fl250YrUnef": "Hello, world!",
    "fl500YrDef": "Hello, world!",
    "fl500YrUndef": "Hello, world!",
    "basinName": "Hello, world!",
    "catchmentId": 1,
    "rms100YrFlZone": "Hello, world!",
    "rms500YrFlZone": "Hello, world!",
    "hdFloodDataResolution": "Hello, world!",
    "hdFloodError": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errorReport": {
      "type": "array"
    },
    "htmlReportOutput": {
      "type": "string"
    },
    "apZoneReport": {
      "type": "object",
      "properties": {
        "apZone": {
          "type": "string"
        },
        "apZoneConfidenceMsg": {
          "type": "string"
        },
        "apZoneError": {
          "type": "string"
        },
        "apResolutionCode": {
          "type": "number"
        }
      }
    },
    "distanceToFaultReport": {
      "type": "object",
      "properties": {
        "nearestFaults": {
          "type": "array"
        },
        "nearestBackgrounds": {
          "type": "array"
        },
        "distanceToFaultError": {
          "type": "string"
        }
      }
    },
    "landslideReport": {
      "type": "object",
      "properties": {
        "landslideValue": {
          "type": "number"
        },
        "landslideDescription": {
          "type": "string"
        },
        "landslideConfidenceMsg": {
          "type": "string"
        },
        "landslideOtherTypes": {
          "type": "string"
        },
        "landslideDataResolution": {
          "type": "string"
        },
        "landslideError": {
          "type": "string"
        },
        "resolutionCode": {
          "type": "number"
        },
        "covariance": {
          "type": "number"
        },
        "hdLandslideMatch": {
          "type": "number"
        },
        "cv": {
          "type": "number"
        }
      }
    },
    "liquefactionReport": {
      "type": "object",
      "properties": {
        "liquefactionValue": {
          "type": "number"
        },
        "liquefactionDescription": {
          "type": "string"
        },
        "liquefactionConfidenceMsg": {
          "type": "string"
        },
        "liquefactionOtherTypes": {
          "type": "string"
        },
        "liquefactionDataResolution": {
          "type": "string"
        },
        "liquefactionError": {
          "type": "string"
        },
        "resolutionCode": {
          "type": "number"
        },
        "covariance": {
          "type": "number"
        },
        "hdLiquefactionMatch": {
          "type": "number"
        },
        "cv": {
          "type": "number"
        }
      }
    },
    "mmiReport": {
      "type": "object",
      "properties": {
        "mmi100": {
          "type": "number"
        },
        "mmi200": {
          "type": "number"
        },
        "mmi250": {
          "type": "number"
        },
        "mmi475": {
          "type": "number"
        },
        "mmiDataResolution": {
          "type": "string"
        },
        "mmiError": {
          "type": "string"
        },
        "resolutionCode": {
          "type": "number"
        }
      }
    },
    "eqRiskProfileReport": {
      "type": "object",
      "properties": {
        "eqRiskProfileR1": {
          "type": "number"
        },
        "eqRiskProfileR2": {
          "type": "number"
        },
        "eqRiskProfileR5": {
          "type": "number"
        },
        "eqRiskProfileRRCounty": {
          "type": "number"
        },
        "eqRiskProfileRRState": {
          "type": "number"
        },
        "eqRiskProfileDataResolution": {
          "type": "string"
        },
        "eqRiskProfileError": {
          "type": "string"
        }
      }
    },
    "eqRiskScoreReport": {
      "type": "object",
      "properties": {
        "eqRiskScore": {
          "type": "string"
        },
        "eqRiskScoreDataResolution": {
          "type": "string"
        },
        "eqRiskScoreError": {
          "type": "string"
        }
      }
    },
    "slopeReport": {
      "type": "object",
      "properties": {
        "slopeAverage": {
          "type": "object",
          "properties": {
            "unit": {
              "type": "string"
            },
            "value": {
              "type": "number"
            }
          }
        },
        "slopeMin": {
          "type": "object",
          "properties": {
            "unit": {
              "type": "string"
            },
            "value": {
              "type": "number"
            }
          }
        },
        "slopeMax": {
          "type": "object",
          "properties": {
            "unit": {
              "type": "string"
            },
            "value": {
              "type": "number"
            }
          }
        },
        "slopeBearingToMin": {
          "type": "string"
        },
        "slopeBearingToMax": {
          "type": "string"
        },
        "slopeConfidence": {
          "type": "string"
        },
        "slopeError": {
          "type": "string"
        }
      }
    },
    "soilReport": {
      "type": "object",
      "properties": {
        "soilValue": {
          "type": "number"
        },
        "soilConfidence": {
          "type": "number"
        },
        "soilDescription": {
          "type": "string"
        },
        "soilConfidenceMsg": {
          "type": "string"
        },
        "soilOtherTypes": {
          "type": "string"
        },
        "soilDataResolution": {
          "type": "string"
        },
        "soilError": {
          "type": "string"
        }
      }
    },
    "distanceToCoastReport": {
      "type": "object",
      "properties": {
        "distanceToCoast": {
          "type": "object",
          "properties": {
            "unit": {
              "type": "string"
            },
            "value": {
              "type": "number"
            }
          }
        },
        "distanceToCoastDataResolution": {
          "type": "string"
        },
        "distanceToCoastError": {
          "type": "string"
        }
      }
    },
    "elevationReport": {
      "type": "object",
      "properties": {
        "elevationAverage": {
          "type": "object",
          "properties": {
            "unit": {
              "type": "string"
            },
            "value": {
              "type": "number"
            }
          }
        },
        "elevationDataResolution": {
          "type": "string"
        },
        "elevationError": {
          "type": "string"
        }
      }
    },
    "huRiskProfileReport": {
      "type": "object",
      "properties": {
        "huRiskProfileR1": {
          "type": "number"
        },
        "huRiskProfileR2": {
          "type": "number"
        },
        "huRiskProfileR5": {
          "type": "number"
        },
        "huRiskProfileRRCounty": {
          "type": "number"
        },
        "huRiskProfileRRState": {
          "type": "number"
        },
        "huRiskProfileDataResolution": {
          "type": "string"
        },
        "huRiskProfileError": {
          "type": "string"
        }
      }
    },
    "huRiskScoreReport": {
      "type": "object",
      "properties": {
        "huRiskScore": {
          "type": "string"
        },
        "huRiskScoreDataResolution": {
          "type": "string"
        },
        "huRiskScoreError": {
          "type": "string"
        }
      }
    },
    "windpoolReport": {
      "type": "object",
      "properties": {
        "windpoolZone": {
          "type": "string"
        },
        "windpoolType": {
          "type": "string"
        },
        "windpoolError": {
          "type": "string"
        },
        "windpoolConfidenceArea": {
          "type": "string"
        }
      }
    },
    "floodReport": {
      "type": "object",
      "properties": {
        "floodAnswerType": {
          "type": "string"
        },
        "floodMapSource": {
          "type": "string"
        },
        "floodZone": {
          "type": "string"
        },
        "floodDescription": {
          "type": "string"
        },
        "floodAnnualProbability": {
          "type": "string"
        },
        "floodConfidence": {
          "type": "number"
        },
        "floodConfidenceMsg": {
          "type": "string"
        },
        "floodBuffer": {
          "type": "object",
          "properties": {
            "unit": {
              "type": "string"
            },
            "value": {
              "type": "number"
            }
          }
        },
        "floodOtherZones": {
          "type": "string"
        },
        "floodBFE": {
          "type": "object",
          "properties": {
            "unit": {
              "type": "string"
            },
            "value": {
              "type": "number"
            }
          }
        },
        "floodAdditionalInfo": {
          "type": "string"
        },
        "floodPanel": {
          "type": "string"
        },
        "floodPanelDate": {
          "type": "string"
        },
        "floodPanelRevision": {
          "type": "string"
        },
        "floodCOBRA": {
          "type": "string"
        },
        "floodWay": {
          "type": "string"
        },
        "floodSFHA": {
          "type": "string"
        },
        "floodCommunity": {
          "type": "string"
        },
        "floodError": {
          "type": "string"
        }
      }
    },
    "wildfireReport": {
      "type": "object",
      "properties": {
        "wildfireHazard": {
          "type": "number"
        },
        "wildfireHazardDescription": {
          "type": "string"
        },
        "wildfireSusceptibility": {
          "type": "number"
        },
        "wildfireSusceptibilityDescription": {
          "type": "string"
        },
        "wildfireThreat": {
          "type": "number"
        },
        "wildfireThreatDescription": {
          "type": "string"
        },
        "wildfireAreaDescription": {
          "type": "string"
        },
        "wildfireFuelType": {
          "type": "string"
        },
        "wildfireFuelTypeDescription": {
          "type": "string"
        },
        "wildfireSpecialConditions": {
          "type": "string"
        },
        "wildfireHistoricalLocalFireAvg": {
          "type": "number"
        },
        "wildfireHistoricalNearbyFireAvg": {
          "type": "number"
        },
        "wildfireAccessibility": {
          "type": "number"
        },
        "wildfireAccessibilityDescription": {
          "type": "string"
        },
        "wildfireDataResolution": {
          "type": "string"
        },
        "wildfireError": {
          "type": "string"
        }
      }
    },
    "scsRiskProfileReport": {
      "type": "object",
      "properties": {
        "scsRiskProfileR20": {
          "type": "number"
        },
        "scsRiskProfileR50": {
          "type": "number"
        },
        "scsRiskProfileR100": {
          "type": "number"
        },
        "scsRiskProfileR250": {
          "type": "number"
        },
        "scsDominantPerilR20": {
          "type": "string"
        },
        "scsDominantPerilR50": {
          "type": "string"
        },
        "scsDominantPerilR100": {
          "type": "string"
        },
        "scsDominantPerilR250": {
          "type": "string"
        },
        "scsRiskProfileRRCounty": {
          "type": "number"
        },
        "scsRiskProfileRRState": {
          "type": "number"
        },
        "scsRiskProfileDataResolution": {
          "type": "string"
        },
        "scsRiskProfileError": {
          "type": "string"
        }
      }
    },
    "scsRiskScoreReport": {
      "type": "object",
      "properties": {
        "scsRiskScore": {
          "type": "string"
        },
        "scsDominantPeril": {
          "type": "string"
        },
        "scsRiskScoreDataResolution": {
          "type": "string"
        },
        "scsRiskScoreError": {
          "type": "string"
        }
      }
    },
    "subsidenceReport": {
      "type": "object",
      "properties": {
        "sinkholeHazardReport": {
          "type": "object",
          "properties": {
            "sinkholeClass": {
              "type": "number"
            },
            "sinkholeDescription": {
              "type": "string"
            },
            "sinkholeConfidenceMsg": {
              "type": "string"
            },
            "sinkholeOtherTypes": {
              "type": "string"
            },
            "sinkholeDataResolution": {
              "type": "string"
            },
            "sinkholeBuffer": {
              "type": "object",
              "properties": {
                "unit": {
                  "type": "string"
                },
                "value": {
                  "type": "number"
                }
              }
            },
            "sinkholeError": {
              "type": "string"
            }
          }
        },
        "distanceToSinkholeReport": {
          "type": "object",
          "properties": {
            "nearestSinkholes": {
              "type": "array"
            },
            "d2SinkholesDataResolution": {
              "type": "string"
            },
            "d2SinkholesBuffer": {
              "type": "object",
              "properties": {
                "unit": {
                  "type": "string"
                },
                "value": {
                  "type": "number"
                }
              }
            },
            "distanceToSinkholeError": {
              "type": "string"
            }
          }
        },
        "distanceToMineReport": {
          "type": "object",
          "properties": {
            "nearestMines": {
              "type": "array"
            },
            "d2MinesDataResolution": {
              "type": "string"
            },
            "d2MinesBuffer": {
              "type": "object",
              "properties": {
                "unit": {
                  "type": "string"
                },
                "value": {
                  "type": "number"
                }
              }
            },
            "distanceToMinesError": {
              "type": "string"
            }
          }
        },
        "subsidenceReportError": {
          "type": "string"
        }
      }
    },
    "stormSurgeReport": {
      "type": "object",
      "properties": {
        "ss100": {
          "type": "string"
        },
        "ss250": {
          "type": "string"
        },
        "ss500": {
          "type": "string"
        },
        "ss1000": {
          "type": "string"
        },
        "stormsurgeDataResolution": {
          "type": "string"
        },
        "stormsurgeError": {
          "type": "string"
        }
      }
    },
    "windRatingScoreReport": {
      "type": "object",
      "properties": {
        "territoryID": {
          "type": "number"
        },
        "territoryCountyCode": {
          "type": "string"
        },
        "aopId": {
          "type": "number"
        },
        "wrs": {
          "type": "number"
        },
        "relativityFactor": {
          "type": "number"
        },
        "getnWRT": {
          "type": "number"
        },
        "windRatingScoreDataResolution": {
          "type": "string"
        },
        "windRatingScoreError": {
          "type": "string"
        }
      }
    },
    "hdFloodReport": {
      "type": "object",
      "properties": {
        "fl100YrDef": {
          "type": "string"
        },
        "fl100YrUndef": {
          "type": "string"
        },
        "fl250YrDef": {
          "type": "string"
        },
        "fl250YrUnef": {
          "type": "string"
        },
        "fl500YrDef": {
          "type": "string"
        },
        "fl500YrUndef": {
          "type": "string"
        },
        "basinName": {
          "type": "string"
        },
        "catchmentId": {
          "type": "number"
        },
        "rms100YrFlZone": {
          "type": "string"
        },
        "rms500YrFlZone": {
          "type": "string"
        },
        "hdFloodDataResolution": {
          "type": "string"
        },
        "hdFloodError": {
          "type": "string"
        }
      }
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Buildingvaluation

valuateBuilding
GET/locations/buildingvaluation{?streetaddress,city,state,postalcode,floorarea,numofstories,yearBuilt,constructioncode,msboccupancycode,buildingtype}

Retrieves valuation for a specified building based on its characteristics.

Example URI

GET /api/v1/locations/buildingvaluation?streetaddress=&city=&state=&postalcode=&floorarea=&numofstories=&yearBuilt=&constructioncode=&msboccupancycode=&buildingtype=
URI Parameters
HideShow
streetaddress
string (required) 

Street address of the building.

city
string (required) 

City where the building resides.

state
string (required) 

State where the building resides.

postalcode
string (required) 

Postal code where the building resides.

floorarea
number (optional) 

Number in square feet of the floor area of the building.

numofstories
number (optional) 

Number of stories of the building.

yearBuilt
number (optional) 

Year the building was constructed.

constructioncode
string (required) 

Construction code of the building.

msboccupancycode
number (optional) 

SB occupancy code of the building.

buildingtype
string (required) 

Type of building.

Response  200
HideShow

OK. Valuation of specified building is successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "value": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "value": {
      "type": "number"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Buildingvaluation

valuateBuildings
PUT/locations/buildingvaluation{?datasource}

Updates the valuation for a specified building based on its characteristics.

Example URI

PUT /api/v1/locations/buildingvaluation?datasource=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
[
  1
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  404
HideShow

Not found. The resource referenced does not exist.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Updatelocationcoveragebldgvaluation

updateLocationCoverageWithBldgValuationForLocations
PUT/locations/updatelocationcoveragebldgvaluation{?datasource}

Updates the coverage with ms/b bldg valuation by locations.

Example URI

PUT /api/v1/locations/updatelocationcoveragebldgvaluation?datasource=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
[
  1
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  404
HideShow

Not found. The resource referenced does not exist.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Enhancedbuildingattributes

updateBuildingAttributesForLocation
PUT/locations/enhancedbuildingattributes{?datasource}

Update building attributes information for locations specified by its ID.

Example URI

PUT /api/v1/locations/enhancedbuildingattributes?datasource=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "updateUnknownOnly": true,
  "locationIds": [
    1
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "updateUnknownOnly": {
      "type": "boolean"
    },
    "locationIds": {
      "type": "array"
    }
  }
}
Response  200
HideShow

OK. Building attributes successfully updated for specific locations

Headers
Content-Type: application/json
Body
"Hello, world!"
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "string"
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  404
HideShow

Not found. The resource referenced does not exist.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations By Id

getLocation
GET/locations/{id}{?datasource}

Retrieves information for a location specified by its ID.

Example URI

GET /api/v1/locations/id?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK. Information for a specified location is successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "property": {
    "accountId": 1,
    "locationId": 1,
    "addressId": 1,
    "locationNumber": "Hello, world!",
    "locationName": "Hello, world!",
    "userId1": "Hello, world!",
    "userId2": "Hello, world!",
    "userText1": "Hello, world!",
    "userText2": "Hello, world!",
    "expireDate": "Hello, world!",
    "inceptDate": "Hello, world!",
    "yearBuilt": "Hello, world!",
    "createDate": "Hello, world!",
    "updateDate": "Hello, world!",
    "buildingClassScheme": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "buildingClass": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "occupancyTypeScheme": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "occupancyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "primaryLocId": 1,
    "siteName": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "buildings": 1,
    "stories": 1,
    "floorOccupancy": "Hello, world!",
    "floorArea": 1,
    "bldgHeight": 1,
    "heightUnit": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "slope": 1,
    "otherZone": "Hello, world!",
    "huZone": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "areaUnit": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "bldgValuation": 1,
    "valuationDiffAmt": 1,
    "valuationDiffPercent": 1,
    "floodDefenseElevation": 1,
    "floodDefenseElevationUnit": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "rentalPropertyIdentifier": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mfdSubcategory": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "dwellTime": 1,
    "userGroundElev": 1,
    "userBfe": 1,
    "floodDefHtAboveGrnd": 1,
    "contentLossTrigger": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "isPrimaryBldg": true,
    "useContentValue": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "nship": 1,
    "isValid": true
  },
  "address": {
    "addressId": 1,
    "area": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "buildingId": "Hello, world!",
    "buildingName": "Hello, world!",
    "addressType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "country": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "countryScheme": "Hello, world!",
    "countryGeoId": 1,
    "countryRmsCode": "Hello, world!",
    "latitude": 1,
    "longitude": 1,
    "addressText": "Hello, world!",
    "streetAddress": "Hello, world!",
    "cityCode": "Hello, world!",
    "cityName": "Hello, world!",
    "cityGeoId": 1,
    "postalCode": "Hello, world!",
    "postalGeoId": 1,
    "block": "Hello, world!",
    "blockGroup": "Hello, world!",
    "locationCode": "Hello, world!",
    "locationCodeGeoId": 1,
    "parcelNumber": "Hello, world!",
    "subLocality": "Hello, world!",
    "geoResolutionConfidence": 1,
    "geoAccuracyBuffer": 1,
    "geoProductVersion": "Hello, world!",
    "geoLocationCode": "Hello, world!",
    "geoMatchCode": "Hello, world!",
    "geoDataSourceId": 1,
    "geoResolutionCode": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "geoDataSourceVersionId": 1,
    "geoDateTime": "Hello, world!",
    "createDateTime": "Hello, world!",
    "updateDateTime": "Hello, world!",
    "admin1Code": "Hello, world!",
    "admin1GeoId": 1,
    "admin1Name": "Hello, world!",
    "admin2Code": "Hello, world!",
    "admin2GeoId": 1,
    "admin2Name": "Hello, world!",
    "admin3Code": "Hello, world!",
    "admin3GeoId": 1,
    "admin3Name": "Hello, world!",
    "admin4Code": "Hello, world!",
    "admin4GeoId": 1,
    "admin4Name": "Hello, world!",
    "admin5Code": "Hello, world!",
    "admin5GeoId": 1,
    "admin5Name": "Hello, world!",
    "zone1GeoId": 1,
    "zone2GeoId": 1,
    "zone3GeoId": 1,
    "zone4GeoId": 1,
    "zone5GeoId": 1,
    "zone1": "Hello, world!",
    "zone2": "Hello, world!",
    "zone3": "Hello, world!",
    "zone3Name": "Hello, world!",
    "zone4Name": "Hello, world!",
    "zone5Name": "Hello, world!",
    "zone3Code": "Hello, world!",
    "zone4Code": "Hello, world!",
    "zone5Code": "Hello, world!",
    "ugid": "Hello, world!"
  },
  "biDetail": {
    "id": 1,
    "redundancy": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "siWaitingPeriod": 1,
    "siLimit": 1,
    "preparedness": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "serviceInterruption": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "isValid": true
  },
  "eqDetail": {
    "id": 1,
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "yearUpgrade": "Hello, world!",
    "startDate": "Hello, world!",
    "completionDate": "Hello, world!",
    "yearSprinkler": "Hello, world!",
    "percentComplete": 1,
    "atcClass": "Hello, world!",
    "isoClass": "Hello, world!",
    "fireClass": "Hello, world!",
    "rmsClass": "Hello, world!",
    "userClass": "Hello, world!",
    "atcOccupancy": "Hello, world!",
    "isoOccupancy": "Hello, world!",
    "sicOccupancy": "Hello, world!",
    "ibcOccupancy": "Hello, world!",
    "userOccupancy": "Hello, world!",
    "secondarySupply": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqslSusceptibility": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "sprinklerType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "baseIsolation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "bldgExterior": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladding": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "constructQuality": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ductility": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "duress": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "enggFoundation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "frameBolt": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "hazardExposed": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "internalMasonaryPart": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "longSpan": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecEquip": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ornamentation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "overhangProfile": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "preFabrication": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "pounding": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "redundancy": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "shapeConfigure": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "shortColumn": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "sidingType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "storyProfile": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "structureUpgrade": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tank": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tiltupRetrofit": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "torsion": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "urmRetrofit": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wallsBrace": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tsDebris": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tsScour": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tsSafeDist": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tsProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "urmChimney": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "builtOnSlope": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "alquistPreoloZone": 1,
    "soil": 1,
    "landslide": 1,
    "liquefaction": 1,
    "biZone": 1,
    "landslideMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "liquefactionMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "soilMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "fireLossMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "landslideCov": 1,
    "liquefactionCov": 1,
    "soilCov": 1,
    "fireLossCov": 1,
    "soilPeriod": 1,
    "soilThickness": 1,
    "fire1": 1,
    "fire2": 1,
    "fire3": 1,
    "fire4": 1,
    "fire5": 1,
    "fire6": 1,
    "fire7": 1,
    "fire8": 1,
    "mmi100": 1,
    "mmi200": 1,
    "mmi250": 1,
    "mmi475": 1,
    "avgSlope": 1,
    "distFault1": 1,
    "apMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mmiMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "distSinkhole": 1,
    "distMine": 1,
    "sinkholeZone": 1,
    "soilVs": 1,
    "soilVsMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "basinLocId": 1,
    "di": 1,
    "critd": 1,
    "n160CS": 1,
    "t15": 1,
    "wff": 1,
    "distriv": 1,
    "gwd": 1,
    "dc": 1,
    "liqcv": 1,
    "hdLiqMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "phi": 1,
    "rough": 1,
    "ndvi": 1,
    "cohes": 1,
    "landcv": 1,
    "hdLandMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqSlope": 1,
    "elev": 1,
    "cti": 1,
    "precip": 1,
    "topo": 1,
    "hdSecMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "isValid": true,
    "eqslInsurance": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    }
  },
  "wsDetail": {
    "id": 1,
    "yearUpgrade": "Hello, world!",
    "startDate": "Hello, world!",
    "completionDate": "Hello, world!",
    "percentComplete": 1,
    "coastalSegment": "Hello, world!",
    "fireClass": "Hello, world!",
    "rmsClass": "Hello, world!",
    "userClass": "Hello, world!",
    "atcOccupancy": "Hello, world!",
    "isoOccupancy": "Hello, world!",
    "sicOccupancy": "Hello, world!",
    "ibcOccupancy": "Hello, world!",
    "userOccupancy": "Hello, world!",
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "isValid": true,
    "architecture": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladRate": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "constructQuality": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "designCode": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "doorOpenings": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "externalOrnament": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodVulnerability": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "foundation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "maintenance": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecSide": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "otherOpenings": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofAge": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofAnchor": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofEquipment": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofFrame": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofGeometry": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofParpet": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofSystem": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windMissile": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windVulnerability": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodMissiles": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodProtection": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "basement": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecGround": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flashing": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ifmVerticalExpDist": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ifmStructCondition": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ifmEquipBracing": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ifmMissileExp": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "resistGarage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsFloorType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsFoundationType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodIndex": 1,
    "distToCoast": 1,
    "sysDistToCoast": 1,
    "elevation": 1,
    "manMadeCov": 1,
    "naturalCov": 1,
    "elevationCov": 1,
    "distToCoastCov": 1,
    "manMadeRoughness": 1,
    "naturalRoughness": 1,
    "windPool": 1,
    "biZone": 1,
    "topologyFeature": 1,
    "elevationMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "naturalRoughnessMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "manMadeRoughnessMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "distToCoastMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windPoolMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windExposure": 1,
    "nfipRate": 1,
    "nfipYear": 1,
    "nfipYearMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "buildingElevation": 1,
    "buildingElevationMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "rmsBuildingElevation": 1,
    "rmsBuildingElevationMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "zoneGroup": 1,
    "perBasement": 1
  },
  "toDetail": {
    "id": 1,
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "yearUpgrade": "Hello, world!",
    "percentComplete": 1,
    "fireClass": "Hello, world!",
    "rmsClass": "Hello, world!",
    "userClass": "Hello, world!",
    "atcOccupancy": "Hello, world!",
    "isoOccupancy": "Hello, world!",
    "userOccupancy": "Hello, world!",
    "isValid": true,
    "architecture": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladRate": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "constructQuality": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "designCode": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "doorOpenings": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "externalOrnament": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodVulnerability": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "foundation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "maintenance": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecSide": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "otherOpenings": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofAge": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofAnchor": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofEquipment": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofFrame": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofGeometry": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofParpet": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofSystem": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windMissile": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windVulnerability": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "basement": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecGround": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodMissiles": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodProtection": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "iceDamProtection": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "plumbingInsulation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "atticInsulation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofVentilation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "snowGuards": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "treeDensity": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "garaging": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "toPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "toProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "toSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "toSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    }
  },
  "flDetail": {
    "id": 1,
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "yearUpgrade": "Hello, world!",
    "startDate": "Hello, world!",
    "completionDate": "Hello, world!",
    "percentComplete": 1,
    "isValid": true,
    "floodProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floorType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodMissile": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "basement": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodVulnerability": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecGround": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "foundation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "duration": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "contamination": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "velocity": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ifmVerticalExpDist": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flFoundationType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodIndex": 1,
    "elevation": 1,
    "elevationCov": 1,
    "annProb": "Hello, world!",
    "flZone": "Hello, world!",
    "bfe": "Hello, world!",
    "additionalInfo": "Hello, world!",
    "panel": "Hello, world!",
    "cobra": "Hello, world!",
    "floodWay": "Hello, world!",
    "sfha": "Hello, world!",
    "community": "Hello, world!",
    "confidence": 1,
    "underRev": "Hello, world!",
    "panelDate": "Hello, world!",
    "buffer": 1,
    "otherZones": "Hello, world!",
    "huZones": "Hello, world!",
    "mapSource": 1,
    "flMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "finishedFloor": 1,
    "userId1": "Hello, world!",
    "userId2": "Hello, world!",
    "basinName": "Hello, world!",
    "catchmentId": 1,
    "floodDriver": "Hello, world!",
    "rms100Flzone": 1,
    "rms500Flzone": 1,
    "fl50YrRpDef": 1,
    "fl75YrRpDef": 1,
    "fl100YrRpDef": 1,
    "fl200YrRpDef": 1,
    "fl250YrRpDef": 1,
    "fl500YrRpDef": 1,
    "fl1000YrRpDef": 1,
    "fl10000YrRpDef": 1,
    "fl50YrRpUndef": 1,
    "fl75YrRpUndef": 1,
    "fl100YrRpUndef": 1,
    "fl200YrRpUndef": 1,
    "fl250YrRpUndef": 1,
    "fl500YrRpUndef": 1,
    "fl1000YrRpUndef": 1,
    "fl10000YrRpUndef": 1,
    "hdFlMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flFfHag": 1,
    "flFfHagFlag": 1,
    "flZoneGroup": 1,
    "flPerBasement": 1
  },
  "frDetail": {
    "id": 1,
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "yearUpgrade": "Hello, world!",
    "startDate": "Hello, world!",
    "completionDate": "Hello, world!",
    "percentComplete": 1,
    "fireDepartmentRatingModifier": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "fireDepartmentRating": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "sprinklerSystem": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "remoteAlarm": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "frPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "frProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "frSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "frSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wildFireHazard": 1,
    "wildFireSusceptibility": 1,
    "wildFireThreat": 1,
    "wildFireAreaDescription": 1,
    "wildFireSurfaceFuelType": "Hello, world!",
    "wildFireSpecialConditions": "Hello, world!",
    "wildFireLocalHistory": 1,
    "wildFireNearbyHistory": 1,
    "wildFireAccessibility": 1,
    "wildFireMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "isValid": true
  },
  "trDetail": {
    "id": 1,
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "yearUpgrade": "Hello, world!",
    "startDate": "Hello, world!",
    "completionDate": "Hello, world!",
    "percentComplete": 1,
    "isValid": true,
    "trPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "trProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "trSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "trSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    }
  },
  "buildingAttribute": {
    "buildingId": "Hello, world!",
    "buildingNumber": "Hello, world!",
    "streetPrefix": "Hello, world!",
    "streetName": "Hello, world!",
    "streetType": "Hello, world!",
    "streetSuffix": "Hello, world!",
    "cityName": "Hello, world!",
    "stateCode": "Hello, world!",
    "country": "Hello, world!",
    "latitude": 1,
    "longitude": 1,
    "buildingClassScheme": "RMS",
    "occupancyTypeScheme": "ATC",
    "derivedStories": 1,
    "areaUnit": "SqFeet",
    "yearRange": 1,
    "exterior": "Hello, world!",
    "fireproof": "Hello, world!",
    "esdbBuildingName": "Hello, world!",
    "esdbBuildingClass": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "esdbOccupancyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "esdbBldgHeight": 1,
    "esdbStories": 1,
    "esdbSquareFootage": 1,
    "esdbYearBuilt": "Hello, world!"
  },
  "coverages": [
    {
      "waitingPeriod": 1,
      "id": 1,
      "label": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "eqslModifier": 1,
      "lossType": "Building",
      "percentSprinkler": 1,
      "value": 1,
      "biPoi": 1,
      "deductible": 1,
      "coverageModifier": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "accumulation": "Building",
      "limit": 1,
      "peril": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "isValid": true
    }
  ],
  "reinsuranceCessions": [
    {
      "id": 1,
      "name": "Hello, world!",
      "exposureId": 1,
      "exposureType": "POL",
      "type": "None",
      "facReinsurer": {
        "id": "Hello, world!",
        "name": "Hello, world!"
      },
      "treaty": {
        "treatyId": 1,
        "treatyNumber": "Hello, world!",
        "treatyName": "Hello, world!",
        "cedant": {
          "id": "Hello, world!",
          "name": "Hello, world!"
        },
        "producer": {
          "id": "Hello, world!",
          "name": "Hello, world!"
        },
        "treatyType": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "currency": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "attachBasis": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "attachLevel": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "premium": 1,
        "occurLimit": 1,
        "attachPt": 1,
        "riskLimit": 1,
        "retentAmt": 1,
        "pcntPlaced": 1,
        "effectDate": "Hello, world!",
        "expireDate": "Hello, world!",
        "pcntRetent": 1,
        "pcntRiShare": 1,
        "pcntCovered": 1,
        "priority": 1,
        "numOfReinst": 1,
        "reinstCharge": 1,
        "maolAmount": 1,
        "isValid": true,
        "userId1": "Hello, world!",
        "userId2": "Hello, world!",
        "lobs": [
          {
            "id": 1,
            "name": "Hello, world!"
          }
        ]
      },
      "layerNumber": 1,
      "layerAmount": 1,
      "excessAmount": 1,
      "percentReinsurance": 1,
      "maolAmount": 1,
      "priority": 1,
      "isValid": true
    }
  ],
  "wcDetails": [
    {
      "id": 1,
      "totalPayroll": 1,
      "totalNumEmployees": 1,
      "numEmployeesShift1": 1,
      "numEmployeesShift2": 1,
      "numEmployeesShift3": 1,
      "numEmployeesShift4": 1,
      "calcNumEmployees": 1,
      "emergencyProtection": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "hazardousMaterials": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "wageRelativity": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "riskManagement": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "employeeDensity": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "undMngtAdjustment": 1,
      "groupNum": "Hello, world!",
      "groupName": "Hello, world!",
      "occupancyTypeScheme": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "occupancyType": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "maxEmployees": 1,
      "shiftType": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "isValid": true,
      "uslh": true,
      "excessComp": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      }
    }
  ],
  "currency": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tiv": 1,
  "riskAssessorCurves": "Hello, world!",
  "locationConditions": [
    {
      "locationId": 1,
      "conditionId": 1,
      "isIncluded": "NotIncluded"
    }
  ],
  "esdbBuildingAttribute": {
    "buildingId": "Hello, world!",
    "buildingNumber": "Hello, world!",
    "streetPrefix": "Hello, world!",
    "streetName": "Hello, world!",
    "streetType": "Hello, world!",
    "streetSuffix": "Hello, world!",
    "cityName": "Hello, world!",
    "stateCode": "Hello, world!",
    "country": "Hello, world!",
    "latitude": 1,
    "longitude": 1,
    "buildingClassScheme": "RMS",
    "occupancyTypeScheme": "ATC",
    "derivedStories": 1,
    "areaUnit": "SqFeet",
    "yearRange": 1,
    "exterior": "Hello, world!",
    "fireproof": "Hello, world!",
    "esdbBuildingName": "Hello, world!",
    "esdbBuildingClass": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "esdbOccupancyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "esdbBldgHeight": 1,
    "esdbStories": 1,
    "esdbSquareFootage": 1,
    "esdbYearBuilt": "Hello, world!"
  },
  "maxCvgBldgValuation": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "property": {
      "type": "object",
      "properties": {
        "accountId": {
          "type": "number"
        },
        "locationId": {
          "type": "number"
        },
        "addressId": {
          "type": "number"
        },
        "locationNumber": {
          "type": "string"
        },
        "locationName": {
          "type": "string"
        },
        "userId1": {
          "type": "string"
        },
        "userId2": {
          "type": "string"
        },
        "userText1": {
          "type": "string"
        },
        "userText2": {
          "type": "string"
        },
        "expireDate": {
          "type": "string"
        },
        "inceptDate": {
          "type": "string"
        },
        "yearBuilt": {
          "type": "string"
        },
        "createDate": {
          "type": "string"
        },
        "updateDate": {
          "type": "string"
        },
        "buildingClassScheme": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "buildingClass": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "occupancyTypeScheme": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "occupancyType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "primaryLocId": {
          "type": "number"
        },
        "siteName": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "buildings": {
          "type": "number"
        },
        "stories": {
          "type": "number"
        },
        "floorOccupancy": {
          "type": "string"
        },
        "floorArea": {
          "type": "number"
        },
        "bldgHeight": {
          "type": "number"
        },
        "heightUnit": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "slope": {
          "type": "number"
        },
        "otherZone": {
          "type": "string"
        },
        "huZone": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "areaUnit": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "bldgValuation": {
          "type": "number"
        },
        "valuationDiffAmt": {
          "type": "number"
        },
        "valuationDiffPercent": {
          "type": "number"
        },
        "floodDefenseElevation": {
          "type": "number"
        },
        "floodDefenseElevationUnit": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "rentalPropertyIdentifier": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mfdSubcategory": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "dwellTime": {
          "type": "number"
        },
        "userGroundElev": {
          "type": "number"
        },
        "userBfe": {
          "type": "number"
        },
        "floodDefHtAboveGrnd": {
          "type": "number"
        },
        "contentLossTrigger": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "isPrimaryBldg": {
          "type": "boolean"
        },
        "useContentValue": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "nship": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        }
      }
    },
    "address": {
      "type": "object",
      "properties": {
        "addressId": {
          "type": "number"
        },
        "area": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "buildingId": {
          "type": "string"
        },
        "buildingName": {
          "type": "string"
        },
        "addressType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "country": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "countryScheme": {
          "type": "string"
        },
        "countryGeoId": {
          "type": "number"
        },
        "countryRmsCode": {
          "type": "string"
        },
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        },
        "addressText": {
          "type": "string"
        },
        "streetAddress": {
          "type": "string"
        },
        "cityCode": {
          "type": "string"
        },
        "cityName": {
          "type": "string"
        },
        "cityGeoId": {
          "type": "number"
        },
        "postalCode": {
          "type": "string"
        },
        "postalGeoId": {
          "type": "number"
        },
        "block": {
          "type": "string"
        },
        "blockGroup": {
          "type": "string"
        },
        "locationCode": {
          "type": "string"
        },
        "locationCodeGeoId": {
          "type": "number"
        },
        "parcelNumber": {
          "type": "string"
        },
        "subLocality": {
          "type": "string"
        },
        "geoResolutionConfidence": {
          "type": "number"
        },
        "geoAccuracyBuffer": {
          "type": "number"
        },
        "geoProductVersion": {
          "type": "string"
        },
        "geoLocationCode": {
          "type": "string"
        },
        "geoMatchCode": {
          "type": "string"
        },
        "geoDataSourceId": {
          "type": "number"
        },
        "geoResolutionCode": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "geoDataSourceVersionId": {
          "type": "number"
        },
        "geoDateTime": {
          "type": "string"
        },
        "createDateTime": {
          "type": "string"
        },
        "updateDateTime": {
          "type": "string"
        },
        "admin1Code": {
          "type": "string"
        },
        "admin1GeoId": {
          "type": "number"
        },
        "admin1Name": {
          "type": "string"
        },
        "admin2Code": {
          "type": "string"
        },
        "admin2GeoId": {
          "type": "number"
        },
        "admin2Name": {
          "type": "string"
        },
        "admin3Code": {
          "type": "string"
        },
        "admin3GeoId": {
          "type": "number"
        },
        "admin3Name": {
          "type": "string"
        },
        "admin4Code": {
          "type": "string"
        },
        "admin4GeoId": {
          "type": "number"
        },
        "admin4Name": {
          "type": "string"
        },
        "admin5Code": {
          "type": "string"
        },
        "admin5GeoId": {
          "type": "number"
        },
        "admin5Name": {
          "type": "string"
        },
        "zone1GeoId": {
          "type": "number"
        },
        "zone2GeoId": {
          "type": "number"
        },
        "zone3GeoId": {
          "type": "number"
        },
        "zone4GeoId": {
          "type": "number"
        },
        "zone5GeoId": {
          "type": "number"
        },
        "zone1": {
          "type": "string"
        },
        "zone2": {
          "type": "string"
        },
        "zone3": {
          "type": "string"
        },
        "zone3Name": {
          "type": "string"
        },
        "zone4Name": {
          "type": "string"
        },
        "zone5Name": {
          "type": "string"
        },
        "zone3Code": {
          "type": "string"
        },
        "zone4Code": {
          "type": "string"
        },
        "zone5Code": {
          "type": "string"
        },
        "ugid": {
          "type": "string"
        }
      }
    },
    "biDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "redundancy": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "siWaitingPeriod": {
          "type": "number"
        },
        "siLimit": {
          "type": "number"
        },
        "preparedness": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "serviceInterruption": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "isValid": {
          "type": "boolean"
        }
      }
    },
    "eqDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "startDate": {
          "type": "string"
        },
        "completionDate": {
          "type": "string"
        },
        "yearSprinkler": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "atcClass": {
          "type": "string"
        },
        "isoClass": {
          "type": "string"
        },
        "fireClass": {
          "type": "string"
        },
        "rmsClass": {
          "type": "string"
        },
        "userClass": {
          "type": "string"
        },
        "atcOccupancy": {
          "type": "string"
        },
        "isoOccupancy": {
          "type": "string"
        },
        "sicOccupancy": {
          "type": "string"
        },
        "ibcOccupancy": {
          "type": "string"
        },
        "userOccupancy": {
          "type": "string"
        },
        "secondarySupply": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqslSusceptibility": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "sprinklerType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "baseIsolation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "bldgExterior": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladding": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "constructQuality": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ductility": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "duress": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "enggFoundation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "frameBolt": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "hazardExposed": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "internalMasonaryPart": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "longSpan": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecEquip": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ornamentation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "overhangProfile": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "preFabrication": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "pounding": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "redundancy": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "shapeConfigure": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "shortColumn": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "sidingType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "storyProfile": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "structureUpgrade": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tank": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tiltupRetrofit": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "torsion": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "urmRetrofit": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wallsBrace": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tsDebris": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tsScour": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tsSafeDist": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tsProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "urmChimney": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "builtOnSlope": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "alquistPreoloZone": {
          "type": "number"
        },
        "soil": {
          "type": "number"
        },
        "landslide": {
          "type": "number"
        },
        "liquefaction": {
          "type": "number"
        },
        "biZone": {
          "type": "number"
        },
        "landslideMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "liquefactionMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "soilMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "fireLossMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "landslideCov": {
          "type": "number"
        },
        "liquefactionCov": {
          "type": "number"
        },
        "soilCov": {
          "type": "number"
        },
        "fireLossCov": {
          "type": "number"
        },
        "soilPeriod": {
          "type": "number"
        },
        "soilThickness": {
          "type": "number"
        },
        "fire1": {
          "type": "number"
        },
        "fire2": {
          "type": "number"
        },
        "fire3": {
          "type": "number"
        },
        "fire4": {
          "type": "number"
        },
        "fire5": {
          "type": "number"
        },
        "fire6": {
          "type": "number"
        },
        "fire7": {
          "type": "number"
        },
        "fire8": {
          "type": "number"
        },
        "mmi100": {
          "type": "number"
        },
        "mmi200": {
          "type": "number"
        },
        "mmi250": {
          "type": "number"
        },
        "mmi475": {
          "type": "number"
        },
        "avgSlope": {
          "type": "number"
        },
        "distFault1": {
          "type": "number"
        },
        "apMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mmiMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "distSinkhole": {
          "type": "number"
        },
        "distMine": {
          "type": "number"
        },
        "sinkholeZone": {
          "type": "number"
        },
        "soilVs": {
          "type": "number"
        },
        "soilVsMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "basinLocId": {
          "type": "number"
        },
        "di": {
          "type": "number"
        },
        "critd": {
          "type": "number"
        },
        "n160CS": {
          "type": "number"
        },
        "t15": {
          "type": "number"
        },
        "wff": {
          "type": "number"
        },
        "distriv": {
          "type": "number"
        },
        "gwd": {
          "type": "number"
        },
        "dc": {
          "type": "number"
        },
        "liqcv": {
          "type": "number"
        },
        "hdLiqMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "phi": {
          "type": "number"
        },
        "rough": {
          "type": "number"
        },
        "ndvi": {
          "type": "number"
        },
        "cohes": {
          "type": "number"
        },
        "landcv": {
          "type": "number"
        },
        "hdLandMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqSlope": {
          "type": "number"
        },
        "elev": {
          "type": "number"
        },
        "cti": {
          "type": "number"
        },
        "precip": {
          "type": "number"
        },
        "topo": {
          "type": "number"
        },
        "hdSecMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "isValid": {
          "type": "boolean"
        },
        "eqslInsurance": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        }
      }
    },
    "wsDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "startDate": {
          "type": "string"
        },
        "completionDate": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "coastalSegment": {
          "type": "string"
        },
        "fireClass": {
          "type": "string"
        },
        "rmsClass": {
          "type": "string"
        },
        "userClass": {
          "type": "string"
        },
        "atcOccupancy": {
          "type": "string"
        },
        "isoOccupancy": {
          "type": "string"
        },
        "sicOccupancy": {
          "type": "string"
        },
        "ibcOccupancy": {
          "type": "string"
        },
        "userOccupancy": {
          "type": "string"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        },
        "architecture": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladRate": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "constructQuality": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "designCode": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "doorOpenings": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "externalOrnament": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodVulnerability": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "foundation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "maintenance": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecSide": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "otherOpenings": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofAge": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofAnchor": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofEquipment": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofFrame": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofGeometry": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofParpet": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofSystem": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windMissile": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windVulnerability": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodMissiles": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodProtection": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "basement": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecGround": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flashing": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ifmVerticalExpDist": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ifmStructCondition": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ifmEquipBracing": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ifmMissileExp": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "resistGarage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsFloorType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsFoundationType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodIndex": {
          "type": "number"
        },
        "distToCoast": {
          "type": "number"
        },
        "sysDistToCoast": {
          "type": "number"
        },
        "elevation": {
          "type": "number"
        },
        "manMadeCov": {
          "type": "number"
        },
        "naturalCov": {
          "type": "number"
        },
        "elevationCov": {
          "type": "number"
        },
        "distToCoastCov": {
          "type": "number"
        },
        "manMadeRoughness": {
          "type": "number"
        },
        "naturalRoughness": {
          "type": "number"
        },
        "windPool": {
          "type": "number"
        },
        "biZone": {
          "type": "number"
        },
        "topologyFeature": {
          "type": "number"
        },
        "elevationMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "naturalRoughnessMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "manMadeRoughnessMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "distToCoastMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windPoolMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windExposure": {
          "type": "number"
        },
        "nfipRate": {
          "type": "number"
        },
        "nfipYear": {
          "type": "number"
        },
        "nfipYearMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "buildingElevation": {
          "type": "number"
        },
        "buildingElevationMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "rmsBuildingElevation": {
          "type": "number"
        },
        "rmsBuildingElevationMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "zoneGroup": {
          "type": "number"
        },
        "perBasement": {
          "type": "number"
        }
      }
    },
    "toDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "fireClass": {
          "type": "string"
        },
        "rmsClass": {
          "type": "string"
        },
        "userClass": {
          "type": "string"
        },
        "atcOccupancy": {
          "type": "string"
        },
        "isoOccupancy": {
          "type": "string"
        },
        "userOccupancy": {
          "type": "string"
        },
        "isValid": {
          "type": "boolean"
        },
        "architecture": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladRate": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "constructQuality": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "designCode": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "doorOpenings": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "externalOrnament": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodVulnerability": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "foundation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "maintenance": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecSide": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "otherOpenings": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofAge": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofAnchor": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofEquipment": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofFrame": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofGeometry": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofParpet": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofSystem": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windMissile": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windVulnerability": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "basement": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecGround": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodMissiles": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodProtection": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "iceDamProtection": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "plumbingInsulation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "atticInsulation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofVentilation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "snowGuards": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "treeDensity": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "garaging": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "toPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "toProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "toSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "toSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        }
      }
    },
    "flDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "startDate": {
          "type": "string"
        },
        "completionDate": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        },
        "floodProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floorType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodMissile": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "basement": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodVulnerability": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecGround": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "foundation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "duration": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "contamination": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "velocity": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ifmVerticalExpDist": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flFoundationType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodIndex": {
          "type": "number"
        },
        "elevation": {
          "type": "number"
        },
        "elevationCov": {
          "type": "number"
        },
        "annProb": {
          "type": "string"
        },
        "flZone": {
          "type": "string"
        },
        "bfe": {
          "type": "string"
        },
        "additionalInfo": {
          "type": "string"
        },
        "panel": {
          "type": "string"
        },
        "cobra": {
          "type": "string"
        },
        "floodWay": {
          "type": "string"
        },
        "sfha": {
          "type": "string"
        },
        "community": {
          "type": "string"
        },
        "confidence": {
          "type": "number"
        },
        "underRev": {
          "type": "string"
        },
        "panelDate": {
          "type": "string"
        },
        "buffer": {
          "type": "number"
        },
        "otherZones": {
          "type": "string"
        },
        "huZones": {
          "type": "string"
        },
        "mapSource": {
          "type": "number"
        },
        "flMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "finishedFloor": {
          "type": "number"
        },
        "userId1": {
          "type": "string"
        },
        "userId2": {
          "type": "string"
        },
        "basinName": {
          "type": "string"
        },
        "catchmentId": {
          "type": "number"
        },
        "floodDriver": {
          "type": "string"
        },
        "rms100Flzone": {
          "type": "number"
        },
        "rms500Flzone": {
          "type": "number"
        },
        "fl50YrRpDef": {
          "type": "number"
        },
        "fl75YrRpDef": {
          "type": "number"
        },
        "fl100YrRpDef": {
          "type": "number"
        },
        "fl200YrRpDef": {
          "type": "number"
        },
        "fl250YrRpDef": {
          "type": "number"
        },
        "fl500YrRpDef": {
          "type": "number"
        },
        "fl1000YrRpDef": {
          "type": "number"
        },
        "fl10000YrRpDef": {
          "type": "number"
        },
        "fl50YrRpUndef": {
          "type": "number"
        },
        "fl75YrRpUndef": {
          "type": "number"
        },
        "fl100YrRpUndef": {
          "type": "number"
        },
        "fl200YrRpUndef": {
          "type": "number"
        },
        "fl250YrRpUndef": {
          "type": "number"
        },
        "fl500YrRpUndef": {
          "type": "number"
        },
        "fl1000YrRpUndef": {
          "type": "number"
        },
        "fl10000YrRpUndef": {
          "type": "number"
        },
        "hdFlMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flFfHag": {
          "type": "number"
        },
        "flFfHagFlag": {
          "type": "number"
        },
        "flZoneGroup": {
          "type": "number"
        },
        "flPerBasement": {
          "type": "number"
        }
      }
    },
    "frDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "startDate": {
          "type": "string"
        },
        "completionDate": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "fireDepartmentRatingModifier": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "fireDepartmentRating": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "sprinklerSystem": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "remoteAlarm": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "frPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "frProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "frSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "frSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wildFireHazard": {
          "type": "number"
        },
        "wildFireSusceptibility": {
          "type": "number"
        },
        "wildFireThreat": {
          "type": "number"
        },
        "wildFireAreaDescription": {
          "type": "number"
        },
        "wildFireSurfaceFuelType": {
          "type": "string"
        },
        "wildFireSpecialConditions": {
          "type": "string"
        },
        "wildFireLocalHistory": {
          "type": "number"
        },
        "wildFireNearbyHistory": {
          "type": "number"
        },
        "wildFireAccessibility": {
          "type": "number"
        },
        "wildFireMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "isValid": {
          "type": "boolean"
        }
      }
    },
    "trDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "startDate": {
          "type": "string"
        },
        "completionDate": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        },
        "trPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "trProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "trSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "trSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        }
      }
    },
    "buildingAttribute": {
      "type": "object",
      "properties": {
        "buildingId": {
          "type": "string"
        },
        "buildingNumber": {
          "type": "string"
        },
        "streetPrefix": {
          "type": "string"
        },
        "streetName": {
          "type": "string"
        },
        "streetType": {
          "type": "string"
        },
        "streetSuffix": {
          "type": "string"
        },
        "cityName": {
          "type": "string"
        },
        "stateCode": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        },
        "buildingClassScheme": {
          "type": "string",
          "enum": [
            "RMS",
            "ATC",
            "ISO",
            "FIRE",
            "RMS_IND",
            "JPBLDG",
            "EURO",
            "RMS_BR",
            "RMS_OP",
            "USER"
          ]
        },
        "occupancyTypeScheme": {
          "type": "string",
          "enum": [
            "ATC",
            "SIC",
            "NAICS",
            "NCCI",
            "ISO",
            "IBC",
            "RMS_IND",
            "JPOCC",
            "EURO",
            "RMS_BR",
            "RMS_OP",
            "WOCC"
          ]
        },
        "derivedStories": {
          "type": "number"
        },
        "areaUnit": {
          "type": "string",
          "enum": [
            "SqFeet",
            "SqMeter"
          ]
        },
        "yearRange": {
          "type": "number"
        },
        "exterior": {
          "type": "string"
        },
        "fireproof": {
          "type": "string"
        },
        "esdbBuildingName": {
          "type": "string"
        },
        "esdbBuildingClass": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "esdbOccupancyType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "esdbBldgHeight": {
          "type": "number"
        },
        "esdbStories": {
          "type": "number"
        },
        "esdbSquareFootage": {
          "type": "number"
        },
        "esdbYearBuilt": {
          "type": "string"
        }
      }
    },
    "coverages": {
      "type": "array"
    },
    "reinsuranceCessions": {
      "type": "array"
    },
    "wcDetails": {
      "type": "array"
    },
    "currency": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tiv": {
      "type": "number"
    },
    "riskAssessorCurves": {
      "type": "string"
    },
    "locationConditions": {
      "type": "array"
    },
    "esdbBuildingAttribute": {
      "type": "object",
      "properties": {
        "buildingId": {
          "type": "string"
        },
        "buildingNumber": {
          "type": "string"
        },
        "streetPrefix": {
          "type": "string"
        },
        "streetName": {
          "type": "string"
        },
        "streetType": {
          "type": "string"
        },
        "streetSuffix": {
          "type": "string"
        },
        "cityName": {
          "type": "string"
        },
        "stateCode": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        },
        "buildingClassScheme": {
          "type": "string",
          "enum": [
            "RMS",
            "ATC",
            "ISO",
            "FIRE",
            "RMS_IND",
            "JPBLDG",
            "EURO",
            "RMS_BR",
            "RMS_OP",
            "USER"
          ]
        },
        "occupancyTypeScheme": {
          "type": "string",
          "enum": [
            "ATC",
            "SIC",
            "NAICS",
            "NCCI",
            "ISO",
            "IBC",
            "RMS_IND",
            "JPOCC",
            "EURO",
            "RMS_BR",
            "RMS_OP",
            "WOCC"
          ]
        },
        "derivedStories": {
          "type": "number"
        },
        "areaUnit": {
          "type": "string",
          "enum": [
            "SqFeet",
            "SqMeter"
          ]
        },
        "yearRange": {
          "type": "number"
        },
        "exterior": {
          "type": "string"
        },
        "fireproof": {
          "type": "string"
        },
        "esdbBuildingName": {
          "type": "string"
        },
        "esdbBuildingClass": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "esdbOccupancyType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "esdbBldgHeight": {
          "type": "number"
        },
        "esdbStories": {
          "type": "number"
        },
        "esdbSquareFootage": {
          "type": "number"
        },
        "esdbYearBuilt": {
          "type": "string"
        }
      }
    },
    "maxCvgBldgValuation": {
      "type": "number"
    }
  },
  "required": [
    "property",
    "address"
  ]
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updateLocation
PUT/locations/{id}{?datasource}

Updates a location

Example URI

PUT /api/v1/locations/id?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "property": {
    "accountId": 1,
    "locationId": 1,
    "addressId": 1,
    "locationNumber": "Hello, world!",
    "locationName": "Hello, world!",
    "userId1": "Hello, world!",
    "userId2": "Hello, world!",
    "userText1": "Hello, world!",
    "userText2": "Hello, world!",
    "expireDate": "Hello, world!",
    "inceptDate": "Hello, world!",
    "yearBuilt": "Hello, world!",
    "createDate": "Hello, world!",
    "updateDate": "Hello, world!",
    "buildingClassScheme": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "buildingClass": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "occupancyTypeScheme": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "occupancyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "primaryLocId": 1,
    "siteName": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "buildings": 1,
    "stories": 1,
    "floorOccupancy": "Hello, world!",
    "floorArea": 1,
    "bldgHeight": 1,
    "heightUnit": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "slope": 1,
    "otherZone": "Hello, world!",
    "huZone": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "areaUnit": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "bldgValuation": 1,
    "valuationDiffAmt": 1,
    "valuationDiffPercent": 1,
    "floodDefenseElevation": 1,
    "floodDefenseElevationUnit": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "rentalPropertyIdentifier": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mfdSubcategory": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "dwellTime": 1,
    "userGroundElev": 1,
    "userBfe": 1,
    "floodDefHtAboveGrnd": 1,
    "contentLossTrigger": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "isPrimaryBldg": true,
    "useContentValue": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "nship": 1,
    "isValid": true
  },
  "address": {
    "addressId": 1,
    "area": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "buildingId": "Hello, world!",
    "buildingName": "Hello, world!",
    "addressType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "country": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "countryScheme": "Hello, world!",
    "countryGeoId": 1,
    "countryRmsCode": "Hello, world!",
    "latitude": 1,
    "longitude": 1,
    "addressText": "Hello, world!",
    "streetAddress": "Hello, world!",
    "cityCode": "Hello, world!",
    "cityName": "Hello, world!",
    "cityGeoId": 1,
    "postalCode": "Hello, world!",
    "postalGeoId": 1,
    "block": "Hello, world!",
    "blockGroup": "Hello, world!",
    "locationCode": "Hello, world!",
    "locationCodeGeoId": 1,
    "parcelNumber": "Hello, world!",
    "subLocality": "Hello, world!",
    "geoResolutionConfidence": 1,
    "geoAccuracyBuffer": 1,
    "geoProductVersion": "Hello, world!",
    "geoLocationCode": "Hello, world!",
    "geoMatchCode": "Hello, world!",
    "geoDataSourceId": 1,
    "geoResolutionCode": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "geoDataSourceVersionId": 1,
    "geoDateTime": "Hello, world!",
    "createDateTime": "Hello, world!",
    "updateDateTime": "Hello, world!",
    "admin1Code": "Hello, world!",
    "admin1GeoId": 1,
    "admin1Name": "Hello, world!",
    "admin2Code": "Hello, world!",
    "admin2GeoId": 1,
    "admin2Name": "Hello, world!",
    "admin3Code": "Hello, world!",
    "admin3GeoId": 1,
    "admin3Name": "Hello, world!",
    "admin4Code": "Hello, world!",
    "admin4GeoId": 1,
    "admin4Name": "Hello, world!",
    "admin5Code": "Hello, world!",
    "admin5GeoId": 1,
    "admin5Name": "Hello, world!",
    "zone1GeoId": 1,
    "zone2GeoId": 1,
    "zone3GeoId": 1,
    "zone4GeoId": 1,
    "zone5GeoId": 1,
    "zone1": "Hello, world!",
    "zone2": "Hello, world!",
    "zone3": "Hello, world!",
    "zone3Name": "Hello, world!",
    "zone4Name": "Hello, world!",
    "zone5Name": "Hello, world!",
    "zone3Code": "Hello, world!",
    "zone4Code": "Hello, world!",
    "zone5Code": "Hello, world!",
    "ugid": "Hello, world!"
  },
  "biDetail": {
    "id": 1,
    "redundancy": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "siWaitingPeriod": 1,
    "siLimit": 1,
    "preparedness": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "serviceInterruption": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "isValid": true
  },
  "eqDetail": {
    "id": 1,
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "yearUpgrade": "Hello, world!",
    "startDate": "Hello, world!",
    "completionDate": "Hello, world!",
    "yearSprinkler": "Hello, world!",
    "percentComplete": 1,
    "atcClass": "Hello, world!",
    "isoClass": "Hello, world!",
    "fireClass": "Hello, world!",
    "rmsClass": "Hello, world!",
    "userClass": "Hello, world!",
    "atcOccupancy": "Hello, world!",
    "isoOccupancy": "Hello, world!",
    "sicOccupancy": "Hello, world!",
    "ibcOccupancy": "Hello, world!",
    "userOccupancy": "Hello, world!",
    "secondarySupply": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqslSusceptibility": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "sprinklerType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "baseIsolation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "bldgExterior": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladding": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "constructQuality": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ductility": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "duress": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "enggFoundation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "frameBolt": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "hazardExposed": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "internalMasonaryPart": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "longSpan": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecEquip": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ornamentation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "overhangProfile": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "preFabrication": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "pounding": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "redundancy": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "shapeConfigure": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "shortColumn": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "sidingType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "storyProfile": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "structureUpgrade": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tank": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tiltupRetrofit": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "torsion": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "urmRetrofit": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wallsBrace": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tsDebris": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tsScour": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tsSafeDist": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tsProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "urmChimney": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "builtOnSlope": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "alquistPreoloZone": 1,
    "soil": 1,
    "landslide": 1,
    "liquefaction": 1,
    "biZone": 1,
    "landslideMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "liquefactionMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "soilMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "fireLossMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "landslideCov": 1,
    "liquefactionCov": 1,
    "soilCov": 1,
    "fireLossCov": 1,
    "soilPeriod": 1,
    "soilThickness": 1,
    "fire1": 1,
    "fire2": 1,
    "fire3": 1,
    "fire4": 1,
    "fire5": 1,
    "fire6": 1,
    "fire7": 1,
    "fire8": 1,
    "mmi100": 1,
    "mmi200": 1,
    "mmi250": 1,
    "mmi475": 1,
    "avgSlope": 1,
    "distFault1": 1,
    "apMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mmiMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "distSinkhole": 1,
    "distMine": 1,
    "sinkholeZone": 1,
    "soilVs": 1,
    "soilVsMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "basinLocId": 1,
    "di": 1,
    "critd": 1,
    "n160CS": 1,
    "t15": 1,
    "wff": 1,
    "distriv": 1,
    "gwd": 1,
    "dc": 1,
    "liqcv": 1,
    "hdLiqMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "phi": 1,
    "rough": 1,
    "ndvi": 1,
    "cohes": 1,
    "landcv": 1,
    "hdLandMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqSlope": 1,
    "elev": 1,
    "cti": 1,
    "precip": 1,
    "topo": 1,
    "hdSecMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "isValid": true,
    "eqslInsurance": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    }
  },
  "wsDetail": {
    "id": 1,
    "yearUpgrade": "Hello, world!",
    "startDate": "Hello, world!",
    "completionDate": "Hello, world!",
    "percentComplete": 1,
    "coastalSegment": "Hello, world!",
    "fireClass": "Hello, world!",
    "rmsClass": "Hello, world!",
    "userClass": "Hello, world!",
    "atcOccupancy": "Hello, world!",
    "isoOccupancy": "Hello, world!",
    "sicOccupancy": "Hello, world!",
    "ibcOccupancy": "Hello, world!",
    "userOccupancy": "Hello, world!",
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "isValid": true,
    "architecture": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladRate": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "constructQuality": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "designCode": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "doorOpenings": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "externalOrnament": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodVulnerability": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "foundation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "maintenance": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecSide": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "otherOpenings": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofAge": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofAnchor": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofEquipment": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofFrame": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofGeometry": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofParpet": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofSystem": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windMissile": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windVulnerability": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodMissiles": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodProtection": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "basement": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecGround": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flashing": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ifmVerticalExpDist": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ifmStructCondition": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ifmEquipBracing": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ifmMissileExp": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "resistGarage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsFloorType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsFoundationType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodIndex": 1,
    "distToCoast": 1,
    "sysDistToCoast": 1,
    "elevation": 1,
    "manMadeCov": 1,
    "naturalCov": 1,
    "elevationCov": 1,
    "distToCoastCov": 1,
    "manMadeRoughness": 1,
    "naturalRoughness": 1,
    "windPool": 1,
    "biZone": 1,
    "topologyFeature": 1,
    "elevationMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "naturalRoughnessMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "manMadeRoughnessMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "distToCoastMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windPoolMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windExposure": 1,
    "nfipRate": 1,
    "nfipYear": 1,
    "nfipYearMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "buildingElevation": 1,
    "buildingElevationMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "rmsBuildingElevation": 1,
    "rmsBuildingElevationMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "zoneGroup": 1,
    "perBasement": 1
  },
  "toDetail": {
    "id": 1,
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "yearUpgrade": "Hello, world!",
    "percentComplete": 1,
    "fireClass": "Hello, world!",
    "rmsClass": "Hello, world!",
    "userClass": "Hello, world!",
    "atcOccupancy": "Hello, world!",
    "isoOccupancy": "Hello, world!",
    "userOccupancy": "Hello, world!",
    "isValid": true,
    "architecture": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladRate": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "constructQuality": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "designCode": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "doorOpenings": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "externalOrnament": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodVulnerability": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "foundation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "maintenance": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecSide": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "otherOpenings": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofAge": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofAnchor": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofEquipment": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofFrame": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofGeometry": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofParpet": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofSystem": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windMissile": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windVulnerability": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "basement": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecGround": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodMissiles": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodProtection": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "iceDamProtection": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "plumbingInsulation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "atticInsulation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofVentilation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "snowGuards": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "treeDensity": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "garaging": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "toPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "toProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "toSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "toSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    }
  },
  "flDetail": {
    "id": 1,
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "yearUpgrade": "Hello, world!",
    "startDate": "Hello, world!",
    "completionDate": "Hello, world!",
    "percentComplete": 1,
    "isValid": true,
    "floodProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floorType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodMissile": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "basement": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodVulnerability": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecGround": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "foundation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "duration": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "contamination": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "velocity": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ifmVerticalExpDist": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flFoundationType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodIndex": 1,
    "elevation": 1,
    "elevationCov": 1,
    "annProb": "Hello, world!",
    "flZone": "Hello, world!",
    "bfe": "Hello, world!",
    "additionalInfo": "Hello, world!",
    "panel": "Hello, world!",
    "cobra": "Hello, world!",
    "floodWay": "Hello, world!",
    "sfha": "Hello, world!",
    "community": "Hello, world!",
    "confidence": 1,
    "underRev": "Hello, world!",
    "panelDate": "Hello, world!",
    "buffer": 1,
    "otherZones": "Hello, world!",
    "huZones": "Hello, world!",
    "mapSource": 1,
    "flMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "finishedFloor": 1,
    "userId1": "Hello, world!",
    "userId2": "Hello, world!",
    "basinName": "Hello, world!",
    "catchmentId": 1,
    "floodDriver": "Hello, world!",
    "rms100Flzone": 1,
    "rms500Flzone": 1,
    "fl50YrRpDef": 1,
    "fl75YrRpDef": 1,
    "fl100YrRpDef": 1,
    "fl200YrRpDef": 1,
    "fl250YrRpDef": 1,
    "fl500YrRpDef": 1,
    "fl1000YrRpDef": 1,
    "fl10000YrRpDef": 1,
    "fl50YrRpUndef": 1,
    "fl75YrRpUndef": 1,
    "fl100YrRpUndef": 1,
    "fl200YrRpUndef": 1,
    "fl250YrRpUndef": 1,
    "fl500YrRpUndef": 1,
    "fl1000YrRpUndef": 1,
    "fl10000YrRpUndef": 1,
    "hdFlMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flFfHag": 1,
    "flFfHagFlag": 1,
    "flZoneGroup": 1,
    "flPerBasement": 1
  },
  "frDetail": {
    "id": 1,
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "yearUpgrade": "Hello, world!",
    "startDate": "Hello, world!",
    "completionDate": "Hello, world!",
    "percentComplete": 1,
    "fireDepartmentRatingModifier": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "fireDepartmentRating": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "sprinklerSystem": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "remoteAlarm": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "frPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "frProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "frSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "frSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wildFireHazard": 1,
    "wildFireSusceptibility": 1,
    "wildFireThreat": 1,
    "wildFireAreaDescription": 1,
    "wildFireSurfaceFuelType": "Hello, world!",
    "wildFireSpecialConditions": "Hello, world!",
    "wildFireLocalHistory": 1,
    "wildFireNearbyHistory": 1,
    "wildFireAccessibility": 1,
    "wildFireMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "isValid": true
  },
  "trDetail": {
    "id": 1,
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "yearUpgrade": "Hello, world!",
    "startDate": "Hello, world!",
    "completionDate": "Hello, world!",
    "percentComplete": 1,
    "isValid": true,
    "trPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "trProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "trSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "trSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    }
  },
  "buildingAttribute": {
    "buildingId": "Hello, world!",
    "buildingNumber": "Hello, world!",
    "streetPrefix": "Hello, world!",
    "streetName": "Hello, world!",
    "streetType": "Hello, world!",
    "streetSuffix": "Hello, world!",
    "cityName": "Hello, world!",
    "stateCode": "Hello, world!",
    "country": "Hello, world!",
    "latitude": 1,
    "longitude": 1,
    "buildingClassScheme": "RMS",
    "occupancyTypeScheme": "ATC",
    "derivedStories": 1,
    "areaUnit": "SqFeet",
    "yearRange": 1,
    "exterior": "Hello, world!",
    "fireproof": "Hello, world!",
    "esdbBuildingName": "Hello, world!",
    "esdbBuildingClass": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "esdbOccupancyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "esdbBldgHeight": 1,
    "esdbStories": 1,
    "esdbSquareFootage": 1,
    "esdbYearBuilt": "Hello, world!"
  },
  "coverages": [
    {
      "waitingPeriod": 1,
      "id": 1,
      "label": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "eqslModifier": 1,
      "lossType": "Building",
      "percentSprinkler": 1,
      "value": 1,
      "biPoi": 1,
      "deductible": 1,
      "coverageModifier": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "accumulation": "Building",
      "limit": 1,
      "peril": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "isValid": true
    }
  ],
  "reinsuranceCessions": [
    {
      "id": 1,
      "name": "Hello, world!",
      "exposureId": 1,
      "exposureType": "POL",
      "type": "None",
      "facReinsurer": {
        "id": "Hello, world!",
        "name": "Hello, world!"
      },
      "treaty": {
        "treatyId": 1,
        "treatyNumber": "Hello, world!",
        "treatyName": "Hello, world!",
        "cedant": {
          "id": "Hello, world!",
          "name": "Hello, world!"
        },
        "producer": {
          "id": "Hello, world!",
          "name": "Hello, world!"
        },
        "treatyType": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "currency": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "attachBasis": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "attachLevel": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "premium": 1,
        "occurLimit": 1,
        "attachPt": 1,
        "riskLimit": 1,
        "retentAmt": 1,
        "pcntPlaced": 1,
        "effectDate": "Hello, world!",
        "expireDate": "Hello, world!",
        "pcntRetent": 1,
        "pcntRiShare": 1,
        "pcntCovered": 1,
        "priority": 1,
        "numOfReinst": 1,
        "reinstCharge": 1,
        "maolAmount": 1,
        "isValid": true,
        "userId1": "Hello, world!",
        "userId2": "Hello, world!",
        "lobs": [
          {
            "id": 1,
            "name": "Hello, world!"
          }
        ]
      },
      "layerNumber": 1,
      "layerAmount": 1,
      "excessAmount": 1,
      "percentReinsurance": 1,
      "maolAmount": 1,
      "priority": 1,
      "isValid": true
    }
  ],
  "wcDetails": [
    {
      "id": 1,
      "totalPayroll": 1,
      "totalNumEmployees": 1,
      "numEmployeesShift1": 1,
      "numEmployeesShift2": 1,
      "numEmployeesShift3": 1,
      "numEmployeesShift4": 1,
      "calcNumEmployees": 1,
      "emergencyProtection": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "hazardousMaterials": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "wageRelativity": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "riskManagement": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "employeeDensity": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "undMngtAdjustment": 1,
      "groupNum": "Hello, world!",
      "groupName": "Hello, world!",
      "occupancyTypeScheme": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "occupancyType": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "maxEmployees": 1,
      "shiftType": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "isValid": true,
      "uslh": true,
      "excessComp": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      }
    }
  ],
  "currency": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tiv": 1,
  "riskAssessorCurves": "Hello, world!",
  "locationConditions": [
    {
      "locationId": 1,
      "conditionId": 1,
      "isIncluded": "NotIncluded"
    }
  ],
  "esdbBuildingAttribute": {
    "buildingId": "Hello, world!",
    "buildingNumber": "Hello, world!",
    "streetPrefix": "Hello, world!",
    "streetName": "Hello, world!",
    "streetType": "Hello, world!",
    "streetSuffix": "Hello, world!",
    "cityName": "Hello, world!",
    "stateCode": "Hello, world!",
    "country": "Hello, world!",
    "latitude": 1,
    "longitude": 1,
    "buildingClassScheme": "RMS",
    "occupancyTypeScheme": "ATC",
    "derivedStories": 1,
    "areaUnit": "SqFeet",
    "yearRange": 1,
    "exterior": "Hello, world!",
    "fireproof": "Hello, world!",
    "esdbBuildingName": "Hello, world!",
    "esdbBuildingClass": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "esdbOccupancyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "esdbBldgHeight": 1,
    "esdbStories": 1,
    "esdbSquareFootage": 1,
    "esdbYearBuilt": "Hello, world!"
  },
  "maxCvgBldgValuation": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "property": {
      "type": "object",
      "properties": {
        "accountId": {
          "type": "number"
        },
        "locationId": {
          "type": "number"
        },
        "addressId": {
          "type": "number"
        },
        "locationNumber": {
          "type": "string"
        },
        "locationName": {
          "type": "string"
        },
        "userId1": {
          "type": "string"
        },
        "userId2": {
          "type": "string"
        },
        "userText1": {
          "type": "string"
        },
        "userText2": {
          "type": "string"
        },
        "expireDate": {
          "type": "string"
        },
        "inceptDate": {
          "type": "string"
        },
        "yearBuilt": {
          "type": "string"
        },
        "createDate": {
          "type": "string"
        },
        "updateDate": {
          "type": "string"
        },
        "buildingClassScheme": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "buildingClass": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "occupancyTypeScheme": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "occupancyType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "primaryLocId": {
          "type": "number"
        },
        "siteName": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "buildings": {
          "type": "number"
        },
        "stories": {
          "type": "number"
        },
        "floorOccupancy": {
          "type": "string"
        },
        "floorArea": {
          "type": "number"
        },
        "bldgHeight": {
          "type": "number"
        },
        "heightUnit": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "slope": {
          "type": "number"
        },
        "otherZone": {
          "type": "string"
        },
        "huZone": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "areaUnit": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "bldgValuation": {
          "type": "number"
        },
        "valuationDiffAmt": {
          "type": "number"
        },
        "valuationDiffPercent": {
          "type": "number"
        },
        "floodDefenseElevation": {
          "type": "number"
        },
        "floodDefenseElevationUnit": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "rentalPropertyIdentifier": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mfdSubcategory": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "dwellTime": {
          "type": "number"
        },
        "userGroundElev": {
          "type": "number"
        },
        "userBfe": {
          "type": "number"
        },
        "floodDefHtAboveGrnd": {
          "type": "number"
        },
        "contentLossTrigger": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "isPrimaryBldg": {
          "type": "boolean"
        },
        "useContentValue": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "nship": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        }
      }
    },
    "address": {
      "type": "object",
      "properties": {
        "addressId": {
          "type": "number"
        },
        "area": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "buildingId": {
          "type": "string"
        },
        "buildingName": {
          "type": "string"
        },
        "addressType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "country": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "countryScheme": {
          "type": "string"
        },
        "countryGeoId": {
          "type": "number"
        },
        "countryRmsCode": {
          "type": "string"
        },
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        },
        "addressText": {
          "type": "string"
        },
        "streetAddress": {
          "type": "string"
        },
        "cityCode": {
          "type": "string"
        },
        "cityName": {
          "type": "string"
        },
        "cityGeoId": {
          "type": "number"
        },
        "postalCode": {
          "type": "string"
        },
        "postalGeoId": {
          "type": "number"
        },
        "block": {
          "type": "string"
        },
        "blockGroup": {
          "type": "string"
        },
        "locationCode": {
          "type": "string"
        },
        "locationCodeGeoId": {
          "type": "number"
        },
        "parcelNumber": {
          "type": "string"
        },
        "subLocality": {
          "type": "string"
        },
        "geoResolutionConfidence": {
          "type": "number"
        },
        "geoAccuracyBuffer": {
          "type": "number"
        },
        "geoProductVersion": {
          "type": "string"
        },
        "geoLocationCode": {
          "type": "string"
        },
        "geoMatchCode": {
          "type": "string"
        },
        "geoDataSourceId": {
          "type": "number"
        },
        "geoResolutionCode": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "geoDataSourceVersionId": {
          "type": "number"
        },
        "geoDateTime": {
          "type": "string"
        },
        "createDateTime": {
          "type": "string"
        },
        "updateDateTime": {
          "type": "string"
        },
        "admin1Code": {
          "type": "string"
        },
        "admin1GeoId": {
          "type": "number"
        },
        "admin1Name": {
          "type": "string"
        },
        "admin2Code": {
          "type": "string"
        },
        "admin2GeoId": {
          "type": "number"
        },
        "admin2Name": {
          "type": "string"
        },
        "admin3Code": {
          "type": "string"
        },
        "admin3GeoId": {
          "type": "number"
        },
        "admin3Name": {
          "type": "string"
        },
        "admin4Code": {
          "type": "string"
        },
        "admin4GeoId": {
          "type": "number"
        },
        "admin4Name": {
          "type": "string"
        },
        "admin5Code": {
          "type": "string"
        },
        "admin5GeoId": {
          "type": "number"
        },
        "admin5Name": {
          "type": "string"
        },
        "zone1GeoId": {
          "type": "number"
        },
        "zone2GeoId": {
          "type": "number"
        },
        "zone3GeoId": {
          "type": "number"
        },
        "zone4GeoId": {
          "type": "number"
        },
        "zone5GeoId": {
          "type": "number"
        },
        "zone1": {
          "type": "string"
        },
        "zone2": {
          "type": "string"
        },
        "zone3": {
          "type": "string"
        },
        "zone3Name": {
          "type": "string"
        },
        "zone4Name": {
          "type": "string"
        },
        "zone5Name": {
          "type": "string"
        },
        "zone3Code": {
          "type": "string"
        },
        "zone4Code": {
          "type": "string"
        },
        "zone5Code": {
          "type": "string"
        },
        "ugid": {
          "type": "string"
        }
      }
    },
    "biDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "redundancy": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "siWaitingPeriod": {
          "type": "number"
        },
        "siLimit": {
          "type": "number"
        },
        "preparedness": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "serviceInterruption": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "isValid": {
          "type": "boolean"
        }
      }
    },
    "eqDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "startDate": {
          "type": "string"
        },
        "completionDate": {
          "type": "string"
        },
        "yearSprinkler": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "atcClass": {
          "type": "string"
        },
        "isoClass": {
          "type": "string"
        },
        "fireClass": {
          "type": "string"
        },
        "rmsClass": {
          "type": "string"
        },
        "userClass": {
          "type": "string"
        },
        "atcOccupancy": {
          "type": "string"
        },
        "isoOccupancy": {
          "type": "string"
        },
        "sicOccupancy": {
          "type": "string"
        },
        "ibcOccupancy": {
          "type": "string"
        },
        "userOccupancy": {
          "type": "string"
        },
        "secondarySupply": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqslSusceptibility": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "sprinklerType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "baseIsolation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "bldgExterior": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladding": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "constructQuality": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ductility": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "duress": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "enggFoundation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "frameBolt": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "hazardExposed": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "internalMasonaryPart": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "longSpan": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecEquip": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ornamentation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "overhangProfile": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "preFabrication": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "pounding": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "redundancy": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "shapeConfigure": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "shortColumn": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "sidingType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "storyProfile": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "structureUpgrade": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tank": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tiltupRetrofit": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "torsion": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "urmRetrofit": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wallsBrace": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tsDebris": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tsScour": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tsSafeDist": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tsProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "urmChimney": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "builtOnSlope": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "alquistPreoloZone": {
          "type": "number"
        },
        "soil": {
          "type": "number"
        },
        "landslide": {
          "type": "number"
        },
        "liquefaction": {
          "type": "number"
        },
        "biZone": {
          "type": "number"
        },
        "landslideMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "liquefactionMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "soilMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "fireLossMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "landslideCov": {
          "type": "number"
        },
        "liquefactionCov": {
          "type": "number"
        },
        "soilCov": {
          "type": "number"
        },
        "fireLossCov": {
          "type": "number"
        },
        "soilPeriod": {
          "type": "number"
        },
        "soilThickness": {
          "type": "number"
        },
        "fire1": {
          "type": "number"
        },
        "fire2": {
          "type": "number"
        },
        "fire3": {
          "type": "number"
        },
        "fire4": {
          "type": "number"
        },
        "fire5": {
          "type": "number"
        },
        "fire6": {
          "type": "number"
        },
        "fire7": {
          "type": "number"
        },
        "fire8": {
          "type": "number"
        },
        "mmi100": {
          "type": "number"
        },
        "mmi200": {
          "type": "number"
        },
        "mmi250": {
          "type": "number"
        },
        "mmi475": {
          "type": "number"
        },
        "avgSlope": {
          "type": "number"
        },
        "distFault1": {
          "type": "number"
        },
        "apMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mmiMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "distSinkhole": {
          "type": "number"
        },
        "distMine": {
          "type": "number"
        },
        "sinkholeZone": {
          "type": "number"
        },
        "soilVs": {
          "type": "number"
        },
        "soilVsMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "basinLocId": {
          "type": "number"
        },
        "di": {
          "type": "number"
        },
        "critd": {
          "type": "number"
        },
        "n160CS": {
          "type": "number"
        },
        "t15": {
          "type": "number"
        },
        "wff": {
          "type": "number"
        },
        "distriv": {
          "type": "number"
        },
        "gwd": {
          "type": "number"
        },
        "dc": {
          "type": "number"
        },
        "liqcv": {
          "type": "number"
        },
        "hdLiqMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "phi": {
          "type": "number"
        },
        "rough": {
          "type": "number"
        },
        "ndvi": {
          "type": "number"
        },
        "cohes": {
          "type": "number"
        },
        "landcv": {
          "type": "number"
        },
        "hdLandMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqSlope": {
          "type": "number"
        },
        "elev": {
          "type": "number"
        },
        "cti": {
          "type": "number"
        },
        "precip": {
          "type": "number"
        },
        "topo": {
          "type": "number"
        },
        "hdSecMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "isValid": {
          "type": "boolean"
        },
        "eqslInsurance": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        }
      }
    },
    "wsDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "startDate": {
          "type": "string"
        },
        "completionDate": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "coastalSegment": {
          "type": "string"
        },
        "fireClass": {
          "type": "string"
        },
        "rmsClass": {
          "type": "string"
        },
        "userClass": {
          "type": "string"
        },
        "atcOccupancy": {
          "type": "string"
        },
        "isoOccupancy": {
          "type": "string"
        },
        "sicOccupancy": {
          "type": "string"
        },
        "ibcOccupancy": {
          "type": "string"
        },
        "userOccupancy": {
          "type": "string"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        },
        "architecture": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladRate": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "constructQuality": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "designCode": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "doorOpenings": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "externalOrnament": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodVulnerability": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "foundation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "maintenance": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecSide": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "otherOpenings": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofAge": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofAnchor": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofEquipment": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofFrame": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofGeometry": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofParpet": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofSystem": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windMissile": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windVulnerability": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodMissiles": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodProtection": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "basement": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecGround": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flashing": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ifmVerticalExpDist": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ifmStructCondition": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ifmEquipBracing": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ifmMissileExp": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "resistGarage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsFloorType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsFoundationType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodIndex": {
          "type": "number"
        },
        "distToCoast": {
          "type": "number"
        },
        "sysDistToCoast": {
          "type": "number"
        },
        "elevation": {
          "type": "number"
        },
        "manMadeCov": {
          "type": "number"
        },
        "naturalCov": {
          "type": "number"
        },
        "elevationCov": {
          "type": "number"
        },
        "distToCoastCov": {
          "type": "number"
        },
        "manMadeRoughness": {
          "type": "number"
        },
        "naturalRoughness": {
          "type": "number"
        },
        "windPool": {
          "type": "number"
        },
        "biZone": {
          "type": "number"
        },
        "topologyFeature": {
          "type": "number"
        },
        "elevationMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "naturalRoughnessMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "manMadeRoughnessMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "distToCoastMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windPoolMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windExposure": {
          "type": "number"
        },
        "nfipRate": {
          "type": "number"
        },
        "nfipYear": {
          "type": "number"
        },
        "nfipYearMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "buildingElevation": {
          "type": "number"
        },
        "buildingElevationMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "rmsBuildingElevation": {
          "type": "number"
        },
        "rmsBuildingElevationMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "zoneGroup": {
          "type": "number"
        },
        "perBasement": {
          "type": "number"
        }
      }
    },
    "toDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "fireClass": {
          "type": "string"
        },
        "rmsClass": {
          "type": "string"
        },
        "userClass": {
          "type": "string"
        },
        "atcOccupancy": {
          "type": "string"
        },
        "isoOccupancy": {
          "type": "string"
        },
        "userOccupancy": {
          "type": "string"
        },
        "isValid": {
          "type": "boolean"
        },
        "architecture": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladRate": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "constructQuality": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "designCode": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "doorOpenings": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "externalOrnament": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodVulnerability": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "foundation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "maintenance": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecSide": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "otherOpenings": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofAge": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofAnchor": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofEquipment": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofFrame": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofGeometry": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofParpet": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofSystem": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windMissile": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windVulnerability": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "basement": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecGround": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodMissiles": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodProtection": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "iceDamProtection": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "plumbingInsulation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "atticInsulation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofVentilation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "snowGuards": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "treeDensity": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "garaging": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "toPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "toProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "toSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "toSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        }
      }
    },
    "flDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "startDate": {
          "type": "string"
        },
        "completionDate": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        },
        "floodProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floorType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodMissile": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "basement": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodVulnerability": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecGround": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "foundation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "duration": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "contamination": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "velocity": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ifmVerticalExpDist": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flFoundationType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodIndex": {
          "type": "number"
        },
        "elevation": {
          "type": "number"
        },
        "elevationCov": {
          "type": "number"
        },
        "annProb": {
          "type": "string"
        },
        "flZone": {
          "type": "string"
        },
        "bfe": {
          "type": "string"
        },
        "additionalInfo": {
          "type": "string"
        },
        "panel": {
          "type": "string"
        },
        "cobra": {
          "type": "string"
        },
        "floodWay": {
          "type": "string"
        },
        "sfha": {
          "type": "string"
        },
        "community": {
          "type": "string"
        },
        "confidence": {
          "type": "number"
        },
        "underRev": {
          "type": "string"
        },
        "panelDate": {
          "type": "string"
        },
        "buffer": {
          "type": "number"
        },
        "otherZones": {
          "type": "string"
        },
        "huZones": {
          "type": "string"
        },
        "mapSource": {
          "type": "number"
        },
        "flMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "finishedFloor": {
          "type": "number"
        },
        "userId1": {
          "type": "string"
        },
        "userId2": {
          "type": "string"
        },
        "basinName": {
          "type": "string"
        },
        "catchmentId": {
          "type": "number"
        },
        "floodDriver": {
          "type": "string"
        },
        "rms100Flzone": {
          "type": "number"
        },
        "rms500Flzone": {
          "type": "number"
        },
        "fl50YrRpDef": {
          "type": "number"
        },
        "fl75YrRpDef": {
          "type": "number"
        },
        "fl100YrRpDef": {
          "type": "number"
        },
        "fl200YrRpDef": {
          "type": "number"
        },
        "fl250YrRpDef": {
          "type": "number"
        },
        "fl500YrRpDef": {
          "type": "number"
        },
        "fl1000YrRpDef": {
          "type": "number"
        },
        "fl10000YrRpDef": {
          "type": "number"
        },
        "fl50YrRpUndef": {
          "type": "number"
        },
        "fl75YrRpUndef": {
          "type": "number"
        },
        "fl100YrRpUndef": {
          "type": "number"
        },
        "fl200YrRpUndef": {
          "type": "number"
        },
        "fl250YrRpUndef": {
          "type": "number"
        },
        "fl500YrRpUndef": {
          "type": "number"
        },
        "fl1000YrRpUndef": {
          "type": "number"
        },
        "fl10000YrRpUndef": {
          "type": "number"
        },
        "hdFlMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flFfHag": {
          "type": "number"
        },
        "flFfHagFlag": {
          "type": "number"
        },
        "flZoneGroup": {
          "type": "number"
        },
        "flPerBasement": {
          "type": "number"
        }
      }
    },
    "frDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "startDate": {
          "type": "string"
        },
        "completionDate": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "fireDepartmentRatingModifier": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "fireDepartmentRating": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "sprinklerSystem": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "remoteAlarm": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "frPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "frProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "frSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "frSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wildFireHazard": {
          "type": "number"
        },
        "wildFireSusceptibility": {
          "type": "number"
        },
        "wildFireThreat": {
          "type": "number"
        },
        "wildFireAreaDescription": {
          "type": "number"
        },
        "wildFireSurfaceFuelType": {
          "type": "string"
        },
        "wildFireSpecialConditions": {
          "type": "string"
        },
        "wildFireLocalHistory": {
          "type": "number"
        },
        "wildFireNearbyHistory": {
          "type": "number"
        },
        "wildFireAccessibility": {
          "type": "number"
        },
        "wildFireMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "isValid": {
          "type": "boolean"
        }
      }
    },
    "trDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "startDate": {
          "type": "string"
        },
        "completionDate": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        },
        "trPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "trProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "trSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "trSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        }
      }
    },
    "buildingAttribute": {
      "type": "object",
      "properties": {
        "buildingId": {
          "type": "string"
        },
        "buildingNumber": {
          "type": "string"
        },
        "streetPrefix": {
          "type": "string"
        },
        "streetName": {
          "type": "string"
        },
        "streetType": {
          "type": "string"
        },
        "streetSuffix": {
          "type": "string"
        },
        "cityName": {
          "type": "string"
        },
        "stateCode": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        },
        "buildingClassScheme": {
          "type": "string",
          "enum": [
            "RMS",
            "ATC",
            "ISO",
            "FIRE",
            "RMS_IND",
            "JPBLDG",
            "EURO",
            "RMS_BR",
            "RMS_OP",
            "USER"
          ]
        },
        "occupancyTypeScheme": {
          "type": "string",
          "enum": [
            "ATC",
            "SIC",
            "NAICS",
            "NCCI",
            "ISO",
            "IBC",
            "RMS_IND",
            "JPOCC",
            "EURO",
            "RMS_BR",
            "RMS_OP",
            "WOCC"
          ]
        },
        "derivedStories": {
          "type": "number"
        },
        "areaUnit": {
          "type": "string",
          "enum": [
            "SqFeet",
            "SqMeter"
          ]
        },
        "yearRange": {
          "type": "number"
        },
        "exterior": {
          "type": "string"
        },
        "fireproof": {
          "type": "string"
        },
        "esdbBuildingName": {
          "type": "string"
        },
        "esdbBuildingClass": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "esdbOccupancyType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "esdbBldgHeight": {
          "type": "number"
        },
        "esdbStories": {
          "type": "number"
        },
        "esdbSquareFootage": {
          "type": "number"
        },
        "esdbYearBuilt": {
          "type": "string"
        }
      }
    },
    "coverages": {
      "type": "array"
    },
    "reinsuranceCessions": {
      "type": "array"
    },
    "wcDetails": {
      "type": "array"
    },
    "currency": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tiv": {
      "type": "number"
    },
    "riskAssessorCurves": {
      "type": "string"
    },
    "locationConditions": {
      "type": "array"
    },
    "esdbBuildingAttribute": {
      "type": "object",
      "properties": {
        "buildingId": {
          "type": "string"
        },
        "buildingNumber": {
          "type": "string"
        },
        "streetPrefix": {
          "type": "string"
        },
        "streetName": {
          "type": "string"
        },
        "streetType": {
          "type": "string"
        },
        "streetSuffix": {
          "type": "string"
        },
        "cityName": {
          "type": "string"
        },
        "stateCode": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        },
        "buildingClassScheme": {
          "type": "string",
          "enum": [
            "RMS",
            "ATC",
            "ISO",
            "FIRE",
            "RMS_IND",
            "JPBLDG",
            "EURO",
            "RMS_BR",
            "RMS_OP",
            "USER"
          ]
        },
        "occupancyTypeScheme": {
          "type": "string",
          "enum": [
            "ATC",
            "SIC",
            "NAICS",
            "NCCI",
            "ISO",
            "IBC",
            "RMS_IND",
            "JPOCC",
            "EURO",
            "RMS_BR",
            "RMS_OP",
            "WOCC"
          ]
        },
        "derivedStories": {
          "type": "number"
        },
        "areaUnit": {
          "type": "string",
          "enum": [
            "SqFeet",
            "SqMeter"
          ]
        },
        "yearRange": {
          "type": "number"
        },
        "exterior": {
          "type": "string"
        },
        "fireproof": {
          "type": "string"
        },
        "esdbBuildingName": {
          "type": "string"
        },
        "esdbBuildingClass": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "esdbOccupancyType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "esdbBldgHeight": {
          "type": "number"
        },
        "esdbStories": {
          "type": "number"
        },
        "esdbSquareFootage": {
          "type": "number"
        },
        "esdbYearBuilt": {
          "type": "string"
        }
      }
    },
    "maxCvgBldgValuation": {
      "type": "number"
    }
  },
  "required": [
    "property",
    "address"
  ]
}
Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

deleteLocation
DELETE/locations/{id}{?datasource}

Deletes a location specified by its ID.

Example URI

DELETE /api/v1/locations/id?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (optional) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations

searchLocations
GET/locations{?datasource,q,sort,limit,offset}

Retrieves list of locations filtered by the specified parameters

Example URI

GET /api/v1/locations?datasource=&q=&sort=&limit=&offset=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

q
string (optional) 

Filters applied to the query results.

sort
string (optional) 

Specify comma-delimited field names followed by ‘ASC’ (to display the results in alphabetical or numerical ascending order) or ‘DESC’ (to display the results in descending order.)

limit
number (optional) 

Maximum number of retrieved records to display on the page.

offset
number (optional) 

Number of the page displaying the returned records, starting at ‘0’.

Response  200
HideShow

OK. List of locations is successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "searchTotalMatch": 1,
  "searchItems": [
    {
      "propertyReference": "Hello, world!",
      "location": {
        "property": {
          "accountId": 1,
          "locationId": 1,
          "addressId": 1,
          "locationNumber": "Hello, world!",
          "locationName": "Hello, world!",
          "userId1": "Hello, world!",
          "userId2": "Hello, world!",
          "userText1": "Hello, world!",
          "userText2": "Hello, world!",
          "expireDate": "Hello, world!",
          "inceptDate": "Hello, world!",
          "yearBuilt": "Hello, world!",
          "createDate": "Hello, world!",
          "updateDate": "Hello, world!",
          "buildingClassScheme": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "buildingClass": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "occupancyTypeScheme": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "occupancyType": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "primaryLocId": 1,
          "siteName": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "buildings": 1,
          "stories": 1,
          "floorOccupancy": "Hello, world!",
          "floorArea": 1,
          "bldgHeight": 1,
          "heightUnit": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "slope": 1,
          "otherZone": "Hello, world!",
          "huZone": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "areaUnit": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "bldgValuation": 1,
          "valuationDiffAmt": 1,
          "valuationDiffPercent": 1,
          "floodDefenseElevation": 1,
          "floodDefenseElevationUnit": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "rentalPropertyIdentifier": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "mfdSubcategory": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "dwellTime": 1,
          "userGroundElev": 1,
          "userBfe": 1,
          "floodDefHtAboveGrnd": 1,
          "contentLossTrigger": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "isPrimaryBldg": true,
          "useContentValue": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "nship": 1,
          "isValid": true
        },
        "address": {
          "addressId": 1,
          "area": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "buildingId": "Hello, world!",
          "buildingName": "Hello, world!",
          "addressType": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "country": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "countryScheme": "Hello, world!",
          "countryGeoId": 1,
          "countryRmsCode": "Hello, world!",
          "latitude": 1,
          "longitude": 1,
          "addressText": "Hello, world!",
          "streetAddress": "Hello, world!",
          "cityCode": "Hello, world!",
          "cityName": "Hello, world!",
          "cityGeoId": 1,
          "postalCode": "Hello, world!",
          "postalGeoId": 1,
          "block": "Hello, world!",
          "blockGroup": "Hello, world!",
          "locationCode": "Hello, world!",
          "locationCodeGeoId": 1,
          "parcelNumber": "Hello, world!",
          "subLocality": "Hello, world!",
          "geoResolutionConfidence": 1,
          "geoAccuracyBuffer": 1,
          "geoProductVersion": "Hello, world!",
          "geoLocationCode": "Hello, world!",
          "geoMatchCode": "Hello, world!",
          "geoDataSourceId": 1,
          "geoResolutionCode": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "geoDataSourceVersionId": 1,
          "geoDateTime": "Hello, world!",
          "createDateTime": "Hello, world!",
          "updateDateTime": "Hello, world!",
          "admin1Code": "Hello, world!",
          "admin1GeoId": 1,
          "admin1Name": "Hello, world!",
          "admin2Code": "Hello, world!",
          "admin2GeoId": 1,
          "admin2Name": "Hello, world!",
          "admin3Code": "Hello, world!",
          "admin3GeoId": 1,
          "admin3Name": "Hello, world!",
          "admin4Code": "Hello, world!",
          "admin4GeoId": 1,
          "admin4Name": "Hello, world!",
          "admin5Code": "Hello, world!",
          "admin5GeoId": 1,
          "admin5Name": "Hello, world!",
          "zone1GeoId": 1,
          "zone2GeoId": 1,
          "zone3GeoId": 1,
          "zone4GeoId": 1,
          "zone5GeoId": 1,
          "zone1": "Hello, world!",
          "zone2": "Hello, world!",
          "zone3": "Hello, world!",
          "zone3Name": "Hello, world!",
          "zone4Name": "Hello, world!",
          "zone5Name": "Hello, world!",
          "zone3Code": "Hello, world!",
          "zone4Code": "Hello, world!",
          "zone5Code": "Hello, world!",
          "ugid": "Hello, world!"
        },
        "biDetail": {
          "id": 1,
          "redundancy": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "siWaitingPeriod": 1,
          "siLimit": 1,
          "preparedness": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "serviceInterruption": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "isValid": true
        },
        "eqDetail": {
          "id": 1,
          "siteLimit": 1,
          "siteDeduct": 1,
          "combinedLimit": 1,
          "combinedDeduct": 1,
          "yearUpgrade": "Hello, world!",
          "startDate": "Hello, world!",
          "completionDate": "Hello, world!",
          "yearSprinkler": "Hello, world!",
          "percentComplete": 1,
          "atcClass": "Hello, world!",
          "isoClass": "Hello, world!",
          "fireClass": "Hello, world!",
          "rmsClass": "Hello, world!",
          "userClass": "Hello, world!",
          "atcOccupancy": "Hello, world!",
          "isoOccupancy": "Hello, world!",
          "sicOccupancy": "Hello, world!",
          "ibcOccupancy": "Hello, world!",
          "userOccupancy": "Hello, world!",
          "secondarySupply": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "eqslSusceptibility": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "sprinklerType": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "baseIsolation": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "bldgExterior": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "cladding": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "constructQuality": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "ductility": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "duress": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "enggFoundation": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "frameBolt": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "hazardExposed": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "internalMasonaryPart": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "longSpan": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "mechElecEquip": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "ornamentation": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "overhangProfile": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "preFabrication": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "pounding": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "redundancy": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "shapeConfigure": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "shortColumn": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "sidingType": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "storyProfile": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "structureUpgrade": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "tank": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "tiltupRetrofit": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "torsion": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "urmRetrofit": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "wallsBrace": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "tsDebris": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "tsScour": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "tsSafeDist": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "tsProtect": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "eqPackage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "eqProtect": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "eqSalvage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "eqSpecieStorage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "urmChimney": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "builtOnSlope": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "alquistPreoloZone": 1,
          "soil": 1,
          "landslide": 1,
          "liquefaction": 1,
          "biZone": 1,
          "landslideMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "liquefactionMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "soilMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "fireLossMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "landslideCov": 1,
          "liquefactionCov": 1,
          "soilCov": 1,
          "fireLossCov": 1,
          "soilPeriod": 1,
          "soilThickness": 1,
          "fire1": 1,
          "fire2": 1,
          "fire3": 1,
          "fire4": 1,
          "fire5": 1,
          "fire6": 1,
          "fire7": 1,
          "fire8": 1,
          "mmi100": 1,
          "mmi200": 1,
          "mmi250": 1,
          "mmi475": 1,
          "avgSlope": 1,
          "distFault1": 1,
          "apMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "mmiMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "distSinkhole": 1,
          "distMine": 1,
          "sinkholeZone": 1,
          "soilVs": 1,
          "soilVsMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "basinLocId": 1,
          "di": 1,
          "critd": 1,
          "n160CS": 1,
          "t15": 1,
          "wff": 1,
          "distriv": 1,
          "gwd": 1,
          "dc": 1,
          "liqcv": 1,
          "hdLiqMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "phi": 1,
          "rough": 1,
          "ndvi": 1,
          "cohes": 1,
          "landcv": 1,
          "hdLandMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "eqSlope": 1,
          "elev": 1,
          "cti": 1,
          "precip": 1,
          "topo": 1,
          "hdSecMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "isValid": true,
          "eqslInsurance": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          }
        },
        "wsDetail": {
          "id": 1,
          "yearUpgrade": "Hello, world!",
          "startDate": "Hello, world!",
          "completionDate": "Hello, world!",
          "percentComplete": 1,
          "coastalSegment": "Hello, world!",
          "fireClass": "Hello, world!",
          "rmsClass": "Hello, world!",
          "userClass": "Hello, world!",
          "atcOccupancy": "Hello, world!",
          "isoOccupancy": "Hello, world!",
          "sicOccupancy": "Hello, world!",
          "ibcOccupancy": "Hello, world!",
          "userOccupancy": "Hello, world!",
          "siteLimit": 1,
          "siteDeduct": 1,
          "combinedLimit": 1,
          "combinedDeduct": 1,
          "isValid": true,
          "architecture": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "cladRate": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "cladType": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "constructQuality": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "designCode": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "doorOpenings": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "externalOrnament": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "floodVulnerability": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "foundation": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "maintenance": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "mechElecSide": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "otherOpenings": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "roofAge": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "roofAnchor": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "roofEquipment": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "roofFrame": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "roofGeometry": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "roofParpet": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "roofSystem": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "windMissile": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "windVulnerability": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "floodMissiles": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "floodProtection": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "basement": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "mechElecGround": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "flashing": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "ifmVerticalExpDist": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "ifmStructCondition": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "ifmEquipBracing": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "ifmMissileExp": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "wsPackage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "wsProtect": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "wsSalvage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "wsSpecieStorage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "resistGarage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "wsFloorType": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "wsFoundationType": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "floodIndex": 1,
          "distToCoast": 1,
          "sysDistToCoast": 1,
          "elevation": 1,
          "manMadeCov": 1,
          "naturalCov": 1,
          "elevationCov": 1,
          "distToCoastCov": 1,
          "manMadeRoughness": 1,
          "naturalRoughness": 1,
          "windPool": 1,
          "biZone": 1,
          "topologyFeature": 1,
          "elevationMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "naturalRoughnessMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "manMadeRoughnessMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "distToCoastMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "windPoolMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "windExposure": 1,
          "nfipRate": 1,
          "nfipYear": 1,
          "nfipYearMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "buildingElevation": 1,
          "buildingElevationMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "rmsBuildingElevation": 1,
          "rmsBuildingElevationMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "zoneGroup": 1,
          "perBasement": 1
        },
        "toDetail": {
          "id": 1,
          "siteLimit": 1,
          "siteDeduct": 1,
          "combinedLimit": 1,
          "combinedDeduct": 1,
          "yearUpgrade": "Hello, world!",
          "percentComplete": 1,
          "fireClass": "Hello, world!",
          "rmsClass": "Hello, world!",
          "userClass": "Hello, world!",
          "atcOccupancy": "Hello, world!",
          "isoOccupancy": "Hello, world!",
          "userOccupancy": "Hello, world!",
          "isValid": true,
          "architecture": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "cladRate": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "cladType": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "constructQuality": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "designCode": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "doorOpenings": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "externalOrnament": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "floodVulnerability": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "foundation": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "maintenance": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "mechElecSide": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "otherOpenings": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "roofAge": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "roofAnchor": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "roofEquipment": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "roofFrame": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "roofGeometry": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "roofParpet": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "roofSystem": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "windMissile": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "windVulnerability": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "basement": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "mechElecGround": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "floodMissiles": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "floodProtection": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "iceDamProtection": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "plumbingInsulation": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "atticInsulation": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "roofVentilation": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "snowGuards": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "treeDensity": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "garaging": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "toPackage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "toProtect": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "toSalvage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "toSpecieStorage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          }
        },
        "flDetail": {
          "id": 1,
          "siteLimit": 1,
          "siteDeduct": 1,
          "combinedLimit": 1,
          "combinedDeduct": 1,
          "yearUpgrade": "Hello, world!",
          "startDate": "Hello, world!",
          "completionDate": "Hello, world!",
          "percentComplete": 1,
          "isValid": true,
          "floodProtect": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "floorType": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "floodMissile": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "basement": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "floodVulnerability": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "mechElecGround": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "cladType": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "foundation": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "duration": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "contamination": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "velocity": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "flPackage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "flProtect": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "flSalvage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "flSpecieStorage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "ifmVerticalExpDist": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "flFoundationType": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "floodIndex": 1,
          "elevation": 1,
          "elevationCov": 1,
          "annProb": "Hello, world!",
          "flZone": "Hello, world!",
          "bfe": "Hello, world!",
          "additionalInfo": "Hello, world!",
          "panel": "Hello, world!",
          "cobra": "Hello, world!",
          "floodWay": "Hello, world!",
          "sfha": "Hello, world!",
          "community": "Hello, world!",
          "confidence": 1,
          "underRev": "Hello, world!",
          "panelDate": "Hello, world!",
          "buffer": 1,
          "otherZones": "Hello, world!",
          "huZones": "Hello, world!",
          "mapSource": 1,
          "flMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "finishedFloor": 1,
          "userId1": "Hello, world!",
          "userId2": "Hello, world!",
          "basinName": "Hello, world!",
          "catchmentId": 1,
          "floodDriver": "Hello, world!",
          "rms100Flzone": 1,
          "rms500Flzone": 1,
          "fl50YrRpDef": 1,
          "fl75YrRpDef": 1,
          "fl100YrRpDef": 1,
          "fl200YrRpDef": 1,
          "fl250YrRpDef": 1,
          "fl500YrRpDef": 1,
          "fl1000YrRpDef": 1,
          "fl10000YrRpDef": 1,
          "fl50YrRpUndef": 1,
          "fl75YrRpUndef": 1,
          "fl100YrRpUndef": 1,
          "fl200YrRpUndef": 1,
          "fl250YrRpUndef": 1,
          "fl500YrRpUndef": 1,
          "fl1000YrRpUndef": 1,
          "fl10000YrRpUndef": 1,
          "hdFlMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "flFfHag": 1,
          "flFfHagFlag": 1,
          "flZoneGroup": 1,
          "flPerBasement": 1
        },
        "frDetail": {
          "id": 1,
          "siteLimit": 1,
          "siteDeduct": 1,
          "combinedLimit": 1,
          "combinedDeduct": 1,
          "yearUpgrade": "Hello, world!",
          "startDate": "Hello, world!",
          "completionDate": "Hello, world!",
          "percentComplete": 1,
          "fireDepartmentRatingModifier": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "fireDepartmentRating": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "sprinklerSystem": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "remoteAlarm": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "frPackage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "frProtect": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "frSalvage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "frSpecieStorage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "wildFireHazard": 1,
          "wildFireSusceptibility": 1,
          "wildFireThreat": 1,
          "wildFireAreaDescription": 1,
          "wildFireSurfaceFuelType": "Hello, world!",
          "wildFireSpecialConditions": "Hello, world!",
          "wildFireLocalHistory": 1,
          "wildFireNearbyHistory": 1,
          "wildFireAccessibility": 1,
          "wildFireMatch": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "isValid": true
        },
        "trDetail": {
          "id": 1,
          "siteLimit": 1,
          "siteDeduct": 1,
          "combinedLimit": 1,
          "combinedDeduct": 1,
          "yearUpgrade": "Hello, world!",
          "startDate": "Hello, world!",
          "completionDate": "Hello, world!",
          "percentComplete": 1,
          "isValid": true,
          "trPackage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "trProtect": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "trSalvage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "trSpecieStorage": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          }
        },
        "buildingAttribute": {
          "buildingId": "Hello, world!",
          "buildingNumber": "Hello, world!",
          "streetPrefix": "Hello, world!",
          "streetName": "Hello, world!",
          "streetType": "Hello, world!",
          "streetSuffix": "Hello, world!",
          "cityName": "Hello, world!",
          "stateCode": "Hello, world!",
          "country": "Hello, world!",
          "latitude": 1,
          "longitude": 1,
          "buildingClassScheme": "RMS",
          "occupancyTypeScheme": "ATC",
          "derivedStories": 1,
          "areaUnit": "SqFeet",
          "yearRange": 1,
          "exterior": "Hello, world!",
          "fireproof": "Hello, world!",
          "esdbBuildingName": "Hello, world!",
          "esdbBuildingClass": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "esdbOccupancyType": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "esdbBldgHeight": 1,
          "esdbStories": 1,
          "esdbSquareFootage": 1,
          "esdbYearBuilt": "Hello, world!"
        },
        "coverages": [
          {
            "waitingPeriod": 1,
            "id": 1,
            "label": {
              "id": 1,
              "code": "Hello, world!",
              "name": "Hello, world!"
            },
            "eqslModifier": 1,
            "lossType": "Building",
            "percentSprinkler": 1,
            "value": 1,
            "biPoi": 1,
            "deductible": 1,
            "coverageModifier": {
              "id": 1,
              "code": "Hello, world!",
              "name": "Hello, world!"
            },
            "accumulation": "Building",
            "limit": 1,
            "peril": {
              "id": 1,
              "code": "Hello, world!",
              "name": "Hello, world!"
            },
            "isValid": true
          }
        ],
        "reinsuranceCessions": [
          {
            "id": 1,
            "name": "Hello, world!",
            "exposureId": 1,
            "exposureType": "POL",
            "type": "None",
            "facReinsurer": {
              "id": "Hello, world!",
              "name": "Hello, world!"
            },
            "treaty": {
              "treatyId": 1,
              "treatyNumber": "Hello, world!",
              "treatyName": "Hello, world!",
              "cedant": {
                "id": "Hello, world!",
                "name": "Hello, world!"
              },
              "producer": {
                "id": "Hello, world!",
                "name": "Hello, world!"
              },
              "treatyType": {
                "id": 1,
                "code": "Hello, world!",
                "name": "Hello, world!"
              },
              "currency": {
                "id": 1,
                "code": "Hello, world!",
                "name": "Hello, world!"
              },
              "attachBasis": {
                "id": 1,
                "code": "Hello, world!",
                "name": "Hello, world!"
              },
              "attachLevel": {
                "id": 1,
                "code": "Hello, world!",
                "name": "Hello, world!"
              },
              "premium": 1,
              "occurLimit": 1,
              "attachPt": 1,
              "riskLimit": 1,
              "retentAmt": 1,
              "pcntPlaced": 1,
              "effectDate": "Hello, world!",
              "expireDate": "Hello, world!",
              "pcntRetent": 1,
              "pcntRiShare": 1,
              "pcntCovered": 1,
              "priority": 1,
              "numOfReinst": 1,
              "reinstCharge": 1,
              "maolAmount": 1,
              "isValid": true,
              "userId1": "Hello, world!",
              "userId2": "Hello, world!",
              "lobs": [
                {
                  "id": 1,
                  "name": "Hello, world!"
                }
              ]
            },
            "layerNumber": 1,
            "layerAmount": 1,
            "excessAmount": 1,
            "percentReinsurance": 1,
            "maolAmount": 1,
            "priority": 1,
            "isValid": true
          }
        ],
        "wcDetails": [
          {
            "id": 1,
            "totalPayroll": 1,
            "totalNumEmployees": 1,
            "numEmployeesShift1": 1,
            "numEmployeesShift2": 1,
            "numEmployeesShift3": 1,
            "numEmployeesShift4": 1,
            "calcNumEmployees": 1,
            "emergencyProtection": {
              "id": 1,
              "code": "Hello, world!",
              "name": "Hello, world!"
            },
            "hazardousMaterials": {
              "id": 1,
              "code": "Hello, world!",
              "name": "Hello, world!"
            },
            "wageRelativity": {
              "id": 1,
              "code": "Hello, world!",
              "name": "Hello, world!"
            },
            "riskManagement": {
              "id": 1,
              "code": "Hello, world!",
              "name": "Hello, world!"
            },
            "employeeDensity": {
              "id": 1,
              "code": "Hello, world!",
              "name": "Hello, world!"
            },
            "undMngtAdjustment": 1,
            "groupNum": "Hello, world!",
            "groupName": "Hello, world!",
            "occupancyTypeScheme": {
              "id": 1,
              "code": "Hello, world!",
              "name": "Hello, world!"
            },
            "occupancyType": {
              "id": 1,
              "code": "Hello, world!",
              "name": "Hello, world!"
            },
            "maxEmployees": 1,
            "shiftType": {
              "id": 1,
              "code": "Hello, world!",
              "name": "Hello, world!"
            },
            "isValid": true,
            "uslh": true,
            "excessComp": {
              "id": 1,
              "code": "Hello, world!",
              "name": "Hello, world!"
            }
          }
        ],
        "currency": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "tiv": 1,
        "riskAssessorCurves": "Hello, world!",
        "locationConditions": [
          {
            "locationId": 1,
            "conditionId": 1,
            "isIncluded": "NotIncluded"
          }
        ],
        "esdbBuildingAttribute": {
          "buildingId": "Hello, world!",
          "buildingNumber": "Hello, world!",
          "streetPrefix": "Hello, world!",
          "streetName": "Hello, world!",
          "streetType": "Hello, world!",
          "streetSuffix": "Hello, world!",
          "cityName": "Hello, world!",
          "stateCode": "Hello, world!",
          "country": "Hello, world!",
          "latitude": 1,
          "longitude": 1,
          "buildingClassScheme": "RMS",
          "occupancyTypeScheme": "ATC",
          "derivedStories": 1,
          "areaUnit": "SqFeet",
          "yearRange": 1,
          "exterior": "Hello, world!",
          "fireproof": "Hello, world!",
          "esdbBuildingName": "Hello, world!",
          "esdbBuildingClass": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "esdbOccupancyType": {
            "id": 1,
            "code": "Hello, world!",
            "name": "Hello, world!"
          },
          "esdbBldgHeight": 1,
          "esdbStories": 1,
          "esdbSquareFootage": 1,
          "esdbYearBuilt": "Hello, world!"
        },
        "maxCvgBldgValuation": 1
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "searchTotalMatch": {
      "type": "number"
    },
    "searchItems": {
      "type": "array"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "links": [
    {
      "rel": "Hello, world!",
      "href": "Hello, world!",
      "method": "Hello, world!"
    }
  ],
  "meta": {
    "createdBy": "Hello, world!",
    "createdAt": "Hello, world!",
    "updatedBy": "Hello, world!",
    "updatedAt": "Hello, world!",
    "count": 1
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "links": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        },
        "updatedBy": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        },
        "count": {
          "type": "number"
        }
      }
    }
  },
  "required": [
    "links",
    "meta"
  ]
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations

createLocation
POST/locations{?datasource}

Creates a new location.

Example URI

POST /api/v1/locations?datasource=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "property": {
    "accountId": 1,
    "locationId": 1,
    "addressId": 1,
    "locationNumber": "Hello, world!",
    "locationName": "Hello, world!",
    "userId1": "Hello, world!",
    "userId2": "Hello, world!",
    "userText1": "Hello, world!",
    "userText2": "Hello, world!",
    "expireDate": "Hello, world!",
    "inceptDate": "Hello, world!",
    "yearBuilt": "Hello, world!",
    "createDate": "Hello, world!",
    "updateDate": "Hello, world!",
    "buildingClassScheme": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "buildingClass": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "occupancyTypeScheme": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "occupancyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "primaryLocId": 1,
    "siteName": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "buildings": 1,
    "stories": 1,
    "floorOccupancy": "Hello, world!",
    "floorArea": 1,
    "bldgHeight": 1,
    "heightUnit": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "slope": 1,
    "otherZone": "Hello, world!",
    "huZone": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "areaUnit": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "bldgValuation": 1,
    "valuationDiffAmt": 1,
    "valuationDiffPercent": 1,
    "floodDefenseElevation": 1,
    "floodDefenseElevationUnit": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "rentalPropertyIdentifier": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mfdSubcategory": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "dwellTime": 1,
    "userGroundElev": 1,
    "userBfe": 1,
    "floodDefHtAboveGrnd": 1,
    "contentLossTrigger": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "isPrimaryBldg": true,
    "useContentValue": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "nship": 1,
    "isValid": true
  },
  "address": {
    "addressId": 1,
    "area": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "buildingId": "Hello, world!",
    "buildingName": "Hello, world!",
    "addressType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "country": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "countryScheme": "Hello, world!",
    "countryGeoId": 1,
    "countryRmsCode": "Hello, world!",
    "latitude": 1,
    "longitude": 1,
    "addressText": "Hello, world!",
    "streetAddress": "Hello, world!",
    "cityCode": "Hello, world!",
    "cityName": "Hello, world!",
    "cityGeoId": 1,
    "postalCode": "Hello, world!",
    "postalGeoId": 1,
    "block": "Hello, world!",
    "blockGroup": "Hello, world!",
    "locationCode": "Hello, world!",
    "locationCodeGeoId": 1,
    "parcelNumber": "Hello, world!",
    "subLocality": "Hello, world!",
    "geoResolutionConfidence": 1,
    "geoAccuracyBuffer": 1,
    "geoProductVersion": "Hello, world!",
    "geoLocationCode": "Hello, world!",
    "geoMatchCode": "Hello, world!",
    "geoDataSourceId": 1,
    "geoResolutionCode": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "geoDataSourceVersionId": 1,
    "geoDateTime": "Hello, world!",
    "createDateTime": "Hello, world!",
    "updateDateTime": "Hello, world!",
    "admin1Code": "Hello, world!",
    "admin1GeoId": 1,
    "admin1Name": "Hello, world!",
    "admin2Code": "Hello, world!",
    "admin2GeoId": 1,
    "admin2Name": "Hello, world!",
    "admin3Code": "Hello, world!",
    "admin3GeoId": 1,
    "admin3Name": "Hello, world!",
    "admin4Code": "Hello, world!",
    "admin4GeoId": 1,
    "admin4Name": "Hello, world!",
    "admin5Code": "Hello, world!",
    "admin5GeoId": 1,
    "admin5Name": "Hello, world!",
    "zone1GeoId": 1,
    "zone2GeoId": 1,
    "zone3GeoId": 1,
    "zone4GeoId": 1,
    "zone5GeoId": 1,
    "zone1": "Hello, world!",
    "zone2": "Hello, world!",
    "zone3": "Hello, world!",
    "zone3Name": "Hello, world!",
    "zone4Name": "Hello, world!",
    "zone5Name": "Hello, world!",
    "zone3Code": "Hello, world!",
    "zone4Code": "Hello, world!",
    "zone5Code": "Hello, world!",
    "ugid": "Hello, world!"
  },
  "biDetail": {
    "id": 1,
    "redundancy": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "siWaitingPeriod": 1,
    "siLimit": 1,
    "preparedness": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "serviceInterruption": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "isValid": true
  },
  "eqDetail": {
    "id": 1,
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "yearUpgrade": "Hello, world!",
    "startDate": "Hello, world!",
    "completionDate": "Hello, world!",
    "yearSprinkler": "Hello, world!",
    "percentComplete": 1,
    "atcClass": "Hello, world!",
    "isoClass": "Hello, world!",
    "fireClass": "Hello, world!",
    "rmsClass": "Hello, world!",
    "userClass": "Hello, world!",
    "atcOccupancy": "Hello, world!",
    "isoOccupancy": "Hello, world!",
    "sicOccupancy": "Hello, world!",
    "ibcOccupancy": "Hello, world!",
    "userOccupancy": "Hello, world!",
    "secondarySupply": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqslSusceptibility": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "sprinklerType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "baseIsolation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "bldgExterior": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladding": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "constructQuality": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ductility": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "duress": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "enggFoundation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "frameBolt": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "hazardExposed": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "internalMasonaryPart": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "longSpan": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecEquip": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ornamentation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "overhangProfile": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "preFabrication": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "pounding": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "redundancy": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "shapeConfigure": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "shortColumn": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "sidingType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "storyProfile": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "structureUpgrade": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tank": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tiltupRetrofit": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "torsion": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "urmRetrofit": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wallsBrace": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tsDebris": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tsScour": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tsSafeDist": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "tsProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "urmChimney": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "builtOnSlope": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "alquistPreoloZone": 1,
    "soil": 1,
    "landslide": 1,
    "liquefaction": 1,
    "biZone": 1,
    "landslideMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "liquefactionMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "soilMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "fireLossMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "landslideCov": 1,
    "liquefactionCov": 1,
    "soilCov": 1,
    "fireLossCov": 1,
    "soilPeriod": 1,
    "soilThickness": 1,
    "fire1": 1,
    "fire2": 1,
    "fire3": 1,
    "fire4": 1,
    "fire5": 1,
    "fire6": 1,
    "fire7": 1,
    "fire8": 1,
    "mmi100": 1,
    "mmi200": 1,
    "mmi250": 1,
    "mmi475": 1,
    "avgSlope": 1,
    "distFault1": 1,
    "apMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mmiMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "distSinkhole": 1,
    "distMine": 1,
    "sinkholeZone": 1,
    "soilVs": 1,
    "soilVsMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "basinLocId": 1,
    "di": 1,
    "critd": 1,
    "n160CS": 1,
    "t15": 1,
    "wff": 1,
    "distriv": 1,
    "gwd": 1,
    "dc": 1,
    "liqcv": 1,
    "hdLiqMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "phi": 1,
    "rough": 1,
    "ndvi": 1,
    "cohes": 1,
    "landcv": 1,
    "hdLandMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "eqSlope": 1,
    "elev": 1,
    "cti": 1,
    "precip": 1,
    "topo": 1,
    "hdSecMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "isValid": true,
    "eqslInsurance": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    }
  },
  "wsDetail": {
    "id": 1,
    "yearUpgrade": "Hello, world!",
    "startDate": "Hello, world!",
    "completionDate": "Hello, world!",
    "percentComplete": 1,
    "coastalSegment": "Hello, world!",
    "fireClass": "Hello, world!",
    "rmsClass": "Hello, world!",
    "userClass": "Hello, world!",
    "atcOccupancy": "Hello, world!",
    "isoOccupancy": "Hello, world!",
    "sicOccupancy": "Hello, world!",
    "ibcOccupancy": "Hello, world!",
    "userOccupancy": "Hello, world!",
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "isValid": true,
    "architecture": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladRate": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "constructQuality": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "designCode": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "doorOpenings": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "externalOrnament": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodVulnerability": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "foundation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "maintenance": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecSide": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "otherOpenings": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofAge": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofAnchor": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofEquipment": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofFrame": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofGeometry": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofParpet": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofSystem": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windMissile": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windVulnerability": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodMissiles": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodProtection": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "basement": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecGround": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flashing": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ifmVerticalExpDist": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ifmStructCondition": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ifmEquipBracing": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ifmMissileExp": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "resistGarage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsFloorType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wsFoundationType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodIndex": 1,
    "distToCoast": 1,
    "sysDistToCoast": 1,
    "elevation": 1,
    "manMadeCov": 1,
    "naturalCov": 1,
    "elevationCov": 1,
    "distToCoastCov": 1,
    "manMadeRoughness": 1,
    "naturalRoughness": 1,
    "windPool": 1,
    "biZone": 1,
    "topologyFeature": 1,
    "elevationMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "naturalRoughnessMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "manMadeRoughnessMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "distToCoastMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windPoolMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windExposure": 1,
    "nfipRate": 1,
    "nfipYear": 1,
    "nfipYearMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "buildingElevation": 1,
    "buildingElevationMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "rmsBuildingElevation": 1,
    "rmsBuildingElevationMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "zoneGroup": 1,
    "perBasement": 1
  },
  "toDetail": {
    "id": 1,
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "yearUpgrade": "Hello, world!",
    "percentComplete": 1,
    "fireClass": "Hello, world!",
    "rmsClass": "Hello, world!",
    "userClass": "Hello, world!",
    "atcOccupancy": "Hello, world!",
    "isoOccupancy": "Hello, world!",
    "userOccupancy": "Hello, world!",
    "isValid": true,
    "architecture": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladRate": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "constructQuality": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "designCode": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "doorOpenings": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "externalOrnament": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodVulnerability": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "foundation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "maintenance": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecSide": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "otherOpenings": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofAge": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofAnchor": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofEquipment": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofFrame": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofGeometry": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofParpet": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofSystem": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windMissile": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "windVulnerability": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "basement": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecGround": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodMissiles": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodProtection": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "iceDamProtection": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "plumbingInsulation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "atticInsulation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "roofVentilation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "snowGuards": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "treeDensity": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "garaging": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "toPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "toProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "toSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "toSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    }
  },
  "flDetail": {
    "id": 1,
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "yearUpgrade": "Hello, world!",
    "startDate": "Hello, world!",
    "completionDate": "Hello, world!",
    "percentComplete": 1,
    "isValid": true,
    "floodProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floorType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodMissile": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "basement": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodVulnerability": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "mechElecGround": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "cladType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "foundation": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "duration": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "contamination": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "velocity": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "ifmVerticalExpDist": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flFoundationType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "floodIndex": 1,
    "elevation": 1,
    "elevationCov": 1,
    "annProb": "Hello, world!",
    "flZone": "Hello, world!",
    "bfe": "Hello, world!",
    "additionalInfo": "Hello, world!",
    "panel": "Hello, world!",
    "cobra": "Hello, world!",
    "floodWay": "Hello, world!",
    "sfha": "Hello, world!",
    "community": "Hello, world!",
    "confidence": 1,
    "underRev": "Hello, world!",
    "panelDate": "Hello, world!",
    "buffer": 1,
    "otherZones": "Hello, world!",
    "huZones": "Hello, world!",
    "mapSource": 1,
    "flMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "finishedFloor": 1,
    "userId1": "Hello, world!",
    "userId2": "Hello, world!",
    "basinName": "Hello, world!",
    "catchmentId": 1,
    "floodDriver": "Hello, world!",
    "rms100Flzone": 1,
    "rms500Flzone": 1,
    "fl50YrRpDef": 1,
    "fl75YrRpDef": 1,
    "fl100YrRpDef": 1,
    "fl200YrRpDef": 1,
    "fl250YrRpDef": 1,
    "fl500YrRpDef": 1,
    "fl1000YrRpDef": 1,
    "fl10000YrRpDef": 1,
    "fl50YrRpUndef": 1,
    "fl75YrRpUndef": 1,
    "fl100YrRpUndef": 1,
    "fl200YrRpUndef": 1,
    "fl250YrRpUndef": 1,
    "fl500YrRpUndef": 1,
    "fl1000YrRpUndef": 1,
    "fl10000YrRpUndef": 1,
    "hdFlMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "flFfHag": 1,
    "flFfHagFlag": 1,
    "flZoneGroup": 1,
    "flPerBasement": 1
  },
  "frDetail": {
    "id": 1,
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "yearUpgrade": "Hello, world!",
    "startDate": "Hello, world!",
    "completionDate": "Hello, world!",
    "percentComplete": 1,
    "fireDepartmentRatingModifier": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "fireDepartmentRating": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "sprinklerSystem": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "remoteAlarm": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "frPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "frProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "frSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "frSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "wildFireHazard": 1,
    "wildFireSusceptibility": 1,
    "wildFireThreat": 1,
    "wildFireAreaDescription": 1,
    "wildFireSurfaceFuelType": "Hello, world!",
    "wildFireSpecialConditions": "Hello, world!",
    "wildFireLocalHistory": 1,
    "wildFireNearbyHistory": 1,
    "wildFireAccessibility": 1,
    "wildFireMatch": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "isValid": true
  },
  "trDetail": {
    "id": 1,
    "siteLimit": 1,
    "siteDeduct": 1,
    "combinedLimit": 1,
    "combinedDeduct": 1,
    "yearUpgrade": "Hello, world!",
    "startDate": "Hello, world!",
    "completionDate": "Hello, world!",
    "percentComplete": 1,
    "isValid": true,
    "trPackage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "trProtect": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "trSalvage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "trSpecieStorage": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    }
  },
  "buildingAttribute": {
    "buildingId": "Hello, world!",
    "buildingNumber": "Hello, world!",
    "streetPrefix": "Hello, world!",
    "streetName": "Hello, world!",
    "streetType": "Hello, world!",
    "streetSuffix": "Hello, world!",
    "cityName": "Hello, world!",
    "stateCode": "Hello, world!",
    "country": "Hello, world!",
    "latitude": 1,
    "longitude": 1,
    "buildingClassScheme": "RMS",
    "occupancyTypeScheme": "ATC",
    "derivedStories": 1,
    "areaUnit": "SqFeet",
    "yearRange": 1,
    "exterior": "Hello, world!",
    "fireproof": "Hello, world!",
    "esdbBuildingName": "Hello, world!",
    "esdbBuildingClass": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "esdbOccupancyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "esdbBldgHeight": 1,
    "esdbStories": 1,
    "esdbSquareFootage": 1,
    "esdbYearBuilt": "Hello, world!"
  },
  "coverages": [
    {
      "waitingPeriod": 1,
      "id": 1,
      "label": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "eqslModifier": 1,
      "lossType": "Building",
      "percentSprinkler": 1,
      "value": 1,
      "biPoi": 1,
      "deductible": 1,
      "coverageModifier": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "accumulation": "Building",
      "limit": 1,
      "peril": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "isValid": true
    }
  ],
  "reinsuranceCessions": [
    {
      "id": 1,
      "name": "Hello, world!",
      "exposureId": 1,
      "exposureType": "POL",
      "type": "None",
      "facReinsurer": {
        "id": "Hello, world!",
        "name": "Hello, world!"
      },
      "treaty": {
        "treatyId": 1,
        "treatyNumber": "Hello, world!",
        "treatyName": "Hello, world!",
        "cedant": {
          "id": "Hello, world!",
          "name": "Hello, world!"
        },
        "producer": {
          "id": "Hello, world!",
          "name": "Hello, world!"
        },
        "treatyType": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "currency": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "attachBasis": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "attachLevel": {
          "id": 1,
          "code": "Hello, world!",
          "name": "Hello, world!"
        },
        "premium": 1,
        "occurLimit": 1,
        "attachPt": 1,
        "riskLimit": 1,
        "retentAmt": 1,
        "pcntPlaced": 1,
        "effectDate": "Hello, world!",
        "expireDate": "Hello, world!",
        "pcntRetent": 1,
        "pcntRiShare": 1,
        "pcntCovered": 1,
        "priority": 1,
        "numOfReinst": 1,
        "reinstCharge": 1,
        "maolAmount": 1,
        "isValid": true,
        "userId1": "Hello, world!",
        "userId2": "Hello, world!",
        "lobs": [
          {
            "id": 1,
            "name": "Hello, world!"
          }
        ]
      },
      "layerNumber": 1,
      "layerAmount": 1,
      "excessAmount": 1,
      "percentReinsurance": 1,
      "maolAmount": 1,
      "priority": 1,
      "isValid": true
    }
  ],
  "wcDetails": [
    {
      "id": 1,
      "totalPayroll": 1,
      "totalNumEmployees": 1,
      "numEmployeesShift1": 1,
      "numEmployeesShift2": 1,
      "numEmployeesShift3": 1,
      "numEmployeesShift4": 1,
      "calcNumEmployees": 1,
      "emergencyProtection": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "hazardousMaterials": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "wageRelativity": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "riskManagement": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "employeeDensity": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "undMngtAdjustment": 1,
      "groupNum": "Hello, world!",
      "groupName": "Hello, world!",
      "occupancyTypeScheme": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "occupancyType": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "maxEmployees": 1,
      "shiftType": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "isValid": true,
      "uslh": true,
      "excessComp": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      }
    }
  ],
  "currency": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "tiv": 1,
  "riskAssessorCurves": "Hello, world!",
  "locationConditions": [
    {
      "locationId": 1,
      "conditionId": 1,
      "isIncluded": "NotIncluded"
    }
  ],
  "esdbBuildingAttribute": {
    "buildingId": "Hello, world!",
    "buildingNumber": "Hello, world!",
    "streetPrefix": "Hello, world!",
    "streetName": "Hello, world!",
    "streetType": "Hello, world!",
    "streetSuffix": "Hello, world!",
    "cityName": "Hello, world!",
    "stateCode": "Hello, world!",
    "country": "Hello, world!",
    "latitude": 1,
    "longitude": 1,
    "buildingClassScheme": "RMS",
    "occupancyTypeScheme": "ATC",
    "derivedStories": 1,
    "areaUnit": "SqFeet",
    "yearRange": 1,
    "exterior": "Hello, world!",
    "fireproof": "Hello, world!",
    "esdbBuildingName": "Hello, world!",
    "esdbBuildingClass": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "esdbOccupancyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "esdbBldgHeight": 1,
    "esdbStories": 1,
    "esdbSquareFootage": 1,
    "esdbYearBuilt": "Hello, world!"
  },
  "maxCvgBldgValuation": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "property": {
      "type": "object",
      "properties": {
        "accountId": {
          "type": "number"
        },
        "locationId": {
          "type": "number"
        },
        "addressId": {
          "type": "number"
        },
        "locationNumber": {
          "type": "string"
        },
        "locationName": {
          "type": "string"
        },
        "userId1": {
          "type": "string"
        },
        "userId2": {
          "type": "string"
        },
        "userText1": {
          "type": "string"
        },
        "userText2": {
          "type": "string"
        },
        "expireDate": {
          "type": "string"
        },
        "inceptDate": {
          "type": "string"
        },
        "yearBuilt": {
          "type": "string"
        },
        "createDate": {
          "type": "string"
        },
        "updateDate": {
          "type": "string"
        },
        "buildingClassScheme": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "buildingClass": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "occupancyTypeScheme": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "occupancyType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "primaryLocId": {
          "type": "number"
        },
        "siteName": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "buildings": {
          "type": "number"
        },
        "stories": {
          "type": "number"
        },
        "floorOccupancy": {
          "type": "string"
        },
        "floorArea": {
          "type": "number"
        },
        "bldgHeight": {
          "type": "number"
        },
        "heightUnit": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "slope": {
          "type": "number"
        },
        "otherZone": {
          "type": "string"
        },
        "huZone": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "areaUnit": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "bldgValuation": {
          "type": "number"
        },
        "valuationDiffAmt": {
          "type": "number"
        },
        "valuationDiffPercent": {
          "type": "number"
        },
        "floodDefenseElevation": {
          "type": "number"
        },
        "floodDefenseElevationUnit": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "rentalPropertyIdentifier": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mfdSubcategory": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "dwellTime": {
          "type": "number"
        },
        "userGroundElev": {
          "type": "number"
        },
        "userBfe": {
          "type": "number"
        },
        "floodDefHtAboveGrnd": {
          "type": "number"
        },
        "contentLossTrigger": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "isPrimaryBldg": {
          "type": "boolean"
        },
        "useContentValue": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "nship": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        }
      }
    },
    "address": {
      "type": "object",
      "properties": {
        "addressId": {
          "type": "number"
        },
        "area": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "buildingId": {
          "type": "string"
        },
        "buildingName": {
          "type": "string"
        },
        "addressType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "country": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "countryScheme": {
          "type": "string"
        },
        "countryGeoId": {
          "type": "number"
        },
        "countryRmsCode": {
          "type": "string"
        },
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        },
        "addressText": {
          "type": "string"
        },
        "streetAddress": {
          "type": "string"
        },
        "cityCode": {
          "type": "string"
        },
        "cityName": {
          "type": "string"
        },
        "cityGeoId": {
          "type": "number"
        },
        "postalCode": {
          "type": "string"
        },
        "postalGeoId": {
          "type": "number"
        },
        "block": {
          "type": "string"
        },
        "blockGroup": {
          "type": "string"
        },
        "locationCode": {
          "type": "string"
        },
        "locationCodeGeoId": {
          "type": "number"
        },
        "parcelNumber": {
          "type": "string"
        },
        "subLocality": {
          "type": "string"
        },
        "geoResolutionConfidence": {
          "type": "number"
        },
        "geoAccuracyBuffer": {
          "type": "number"
        },
        "geoProductVersion": {
          "type": "string"
        },
        "geoLocationCode": {
          "type": "string"
        },
        "geoMatchCode": {
          "type": "string"
        },
        "geoDataSourceId": {
          "type": "number"
        },
        "geoResolutionCode": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "geoDataSourceVersionId": {
          "type": "number"
        },
        "geoDateTime": {
          "type": "string"
        },
        "createDateTime": {
          "type": "string"
        },
        "updateDateTime": {
          "type": "string"
        },
        "admin1Code": {
          "type": "string"
        },
        "admin1GeoId": {
          "type": "number"
        },
        "admin1Name": {
          "type": "string"
        },
        "admin2Code": {
          "type": "string"
        },
        "admin2GeoId": {
          "type": "number"
        },
        "admin2Name": {
          "type": "string"
        },
        "admin3Code": {
          "type": "string"
        },
        "admin3GeoId": {
          "type": "number"
        },
        "admin3Name": {
          "type": "string"
        },
        "admin4Code": {
          "type": "string"
        },
        "admin4GeoId": {
          "type": "number"
        },
        "admin4Name": {
          "type": "string"
        },
        "admin5Code": {
          "type": "string"
        },
        "admin5GeoId": {
          "type": "number"
        },
        "admin5Name": {
          "type": "string"
        },
        "zone1GeoId": {
          "type": "number"
        },
        "zone2GeoId": {
          "type": "number"
        },
        "zone3GeoId": {
          "type": "number"
        },
        "zone4GeoId": {
          "type": "number"
        },
        "zone5GeoId": {
          "type": "number"
        },
        "zone1": {
          "type": "string"
        },
        "zone2": {
          "type": "string"
        },
        "zone3": {
          "type": "string"
        },
        "zone3Name": {
          "type": "string"
        },
        "zone4Name": {
          "type": "string"
        },
        "zone5Name": {
          "type": "string"
        },
        "zone3Code": {
          "type": "string"
        },
        "zone4Code": {
          "type": "string"
        },
        "zone5Code": {
          "type": "string"
        },
        "ugid": {
          "type": "string"
        }
      }
    },
    "biDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "redundancy": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "siWaitingPeriod": {
          "type": "number"
        },
        "siLimit": {
          "type": "number"
        },
        "preparedness": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "serviceInterruption": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "isValid": {
          "type": "boolean"
        }
      }
    },
    "eqDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "startDate": {
          "type": "string"
        },
        "completionDate": {
          "type": "string"
        },
        "yearSprinkler": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "atcClass": {
          "type": "string"
        },
        "isoClass": {
          "type": "string"
        },
        "fireClass": {
          "type": "string"
        },
        "rmsClass": {
          "type": "string"
        },
        "userClass": {
          "type": "string"
        },
        "atcOccupancy": {
          "type": "string"
        },
        "isoOccupancy": {
          "type": "string"
        },
        "sicOccupancy": {
          "type": "string"
        },
        "ibcOccupancy": {
          "type": "string"
        },
        "userOccupancy": {
          "type": "string"
        },
        "secondarySupply": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqslSusceptibility": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "sprinklerType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "baseIsolation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "bldgExterior": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladding": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "constructQuality": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ductility": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "duress": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "enggFoundation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "frameBolt": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "hazardExposed": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "internalMasonaryPart": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "longSpan": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecEquip": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ornamentation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "overhangProfile": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "preFabrication": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "pounding": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "redundancy": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "shapeConfigure": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "shortColumn": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "sidingType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "storyProfile": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "structureUpgrade": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tank": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tiltupRetrofit": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "torsion": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "urmRetrofit": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wallsBrace": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tsDebris": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tsScour": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tsSafeDist": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "tsProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "urmChimney": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "builtOnSlope": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "alquistPreoloZone": {
          "type": "number"
        },
        "soil": {
          "type": "number"
        },
        "landslide": {
          "type": "number"
        },
        "liquefaction": {
          "type": "number"
        },
        "biZone": {
          "type": "number"
        },
        "landslideMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "liquefactionMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "soilMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "fireLossMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "landslideCov": {
          "type": "number"
        },
        "liquefactionCov": {
          "type": "number"
        },
        "soilCov": {
          "type": "number"
        },
        "fireLossCov": {
          "type": "number"
        },
        "soilPeriod": {
          "type": "number"
        },
        "soilThickness": {
          "type": "number"
        },
        "fire1": {
          "type": "number"
        },
        "fire2": {
          "type": "number"
        },
        "fire3": {
          "type": "number"
        },
        "fire4": {
          "type": "number"
        },
        "fire5": {
          "type": "number"
        },
        "fire6": {
          "type": "number"
        },
        "fire7": {
          "type": "number"
        },
        "fire8": {
          "type": "number"
        },
        "mmi100": {
          "type": "number"
        },
        "mmi200": {
          "type": "number"
        },
        "mmi250": {
          "type": "number"
        },
        "mmi475": {
          "type": "number"
        },
        "avgSlope": {
          "type": "number"
        },
        "distFault1": {
          "type": "number"
        },
        "apMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mmiMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "distSinkhole": {
          "type": "number"
        },
        "distMine": {
          "type": "number"
        },
        "sinkholeZone": {
          "type": "number"
        },
        "soilVs": {
          "type": "number"
        },
        "soilVsMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "basinLocId": {
          "type": "number"
        },
        "di": {
          "type": "number"
        },
        "critd": {
          "type": "number"
        },
        "n160CS": {
          "type": "number"
        },
        "t15": {
          "type": "number"
        },
        "wff": {
          "type": "number"
        },
        "distriv": {
          "type": "number"
        },
        "gwd": {
          "type": "number"
        },
        "dc": {
          "type": "number"
        },
        "liqcv": {
          "type": "number"
        },
        "hdLiqMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "phi": {
          "type": "number"
        },
        "rough": {
          "type": "number"
        },
        "ndvi": {
          "type": "number"
        },
        "cohes": {
          "type": "number"
        },
        "landcv": {
          "type": "number"
        },
        "hdLandMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "eqSlope": {
          "type": "number"
        },
        "elev": {
          "type": "number"
        },
        "cti": {
          "type": "number"
        },
        "precip": {
          "type": "number"
        },
        "topo": {
          "type": "number"
        },
        "hdSecMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "isValid": {
          "type": "boolean"
        },
        "eqslInsurance": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        }
      }
    },
    "wsDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "startDate": {
          "type": "string"
        },
        "completionDate": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "coastalSegment": {
          "type": "string"
        },
        "fireClass": {
          "type": "string"
        },
        "rmsClass": {
          "type": "string"
        },
        "userClass": {
          "type": "string"
        },
        "atcOccupancy": {
          "type": "string"
        },
        "isoOccupancy": {
          "type": "string"
        },
        "sicOccupancy": {
          "type": "string"
        },
        "ibcOccupancy": {
          "type": "string"
        },
        "userOccupancy": {
          "type": "string"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        },
        "architecture": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladRate": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "constructQuality": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "designCode": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "doorOpenings": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "externalOrnament": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodVulnerability": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "foundation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "maintenance": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecSide": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "otherOpenings": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofAge": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofAnchor": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofEquipment": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofFrame": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofGeometry": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofParpet": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofSystem": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windMissile": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windVulnerability": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodMissiles": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodProtection": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "basement": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecGround": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flashing": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ifmVerticalExpDist": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ifmStructCondition": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ifmEquipBracing": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ifmMissileExp": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "resistGarage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsFloorType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wsFoundationType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodIndex": {
          "type": "number"
        },
        "distToCoast": {
          "type": "number"
        },
        "sysDistToCoast": {
          "type": "number"
        },
        "elevation": {
          "type": "number"
        },
        "manMadeCov": {
          "type": "number"
        },
        "naturalCov": {
          "type": "number"
        },
        "elevationCov": {
          "type": "number"
        },
        "distToCoastCov": {
          "type": "number"
        },
        "manMadeRoughness": {
          "type": "number"
        },
        "naturalRoughness": {
          "type": "number"
        },
        "windPool": {
          "type": "number"
        },
        "biZone": {
          "type": "number"
        },
        "topologyFeature": {
          "type": "number"
        },
        "elevationMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "naturalRoughnessMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "manMadeRoughnessMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "distToCoastMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windPoolMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windExposure": {
          "type": "number"
        },
        "nfipRate": {
          "type": "number"
        },
        "nfipYear": {
          "type": "number"
        },
        "nfipYearMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "buildingElevation": {
          "type": "number"
        },
        "buildingElevationMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "rmsBuildingElevation": {
          "type": "number"
        },
        "rmsBuildingElevationMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "zoneGroup": {
          "type": "number"
        },
        "perBasement": {
          "type": "number"
        }
      }
    },
    "toDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "fireClass": {
          "type": "string"
        },
        "rmsClass": {
          "type": "string"
        },
        "userClass": {
          "type": "string"
        },
        "atcOccupancy": {
          "type": "string"
        },
        "isoOccupancy": {
          "type": "string"
        },
        "userOccupancy": {
          "type": "string"
        },
        "isValid": {
          "type": "boolean"
        },
        "architecture": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladRate": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "constructQuality": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "designCode": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "doorOpenings": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "externalOrnament": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodVulnerability": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "foundation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "maintenance": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecSide": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "otherOpenings": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofAge": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofAnchor": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofEquipment": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofFrame": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofGeometry": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofParpet": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofSystem": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windMissile": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "windVulnerability": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "basement": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecGround": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodMissiles": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodProtection": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "iceDamProtection": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "plumbingInsulation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "atticInsulation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "roofVentilation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "snowGuards": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "treeDensity": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "garaging": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "toPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "toProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "toSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "toSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        }
      }
    },
    "flDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "startDate": {
          "type": "string"
        },
        "completionDate": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        },
        "floodProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floorType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodMissile": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "basement": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodVulnerability": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "mechElecGround": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "cladType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "foundation": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "duration": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "contamination": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "velocity": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "ifmVerticalExpDist": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flFoundationType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "floodIndex": {
          "type": "number"
        },
        "elevation": {
          "type": "number"
        },
        "elevationCov": {
          "type": "number"
        },
        "annProb": {
          "type": "string"
        },
        "flZone": {
          "type": "string"
        },
        "bfe": {
          "type": "string"
        },
        "additionalInfo": {
          "type": "string"
        },
        "panel": {
          "type": "string"
        },
        "cobra": {
          "type": "string"
        },
        "floodWay": {
          "type": "string"
        },
        "sfha": {
          "type": "string"
        },
        "community": {
          "type": "string"
        },
        "confidence": {
          "type": "number"
        },
        "underRev": {
          "type": "string"
        },
        "panelDate": {
          "type": "string"
        },
        "buffer": {
          "type": "number"
        },
        "otherZones": {
          "type": "string"
        },
        "huZones": {
          "type": "string"
        },
        "mapSource": {
          "type": "number"
        },
        "flMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "finishedFloor": {
          "type": "number"
        },
        "userId1": {
          "type": "string"
        },
        "userId2": {
          "type": "string"
        },
        "basinName": {
          "type": "string"
        },
        "catchmentId": {
          "type": "number"
        },
        "floodDriver": {
          "type": "string"
        },
        "rms100Flzone": {
          "type": "number"
        },
        "rms500Flzone": {
          "type": "number"
        },
        "fl50YrRpDef": {
          "type": "number"
        },
        "fl75YrRpDef": {
          "type": "number"
        },
        "fl100YrRpDef": {
          "type": "number"
        },
        "fl200YrRpDef": {
          "type": "number"
        },
        "fl250YrRpDef": {
          "type": "number"
        },
        "fl500YrRpDef": {
          "type": "number"
        },
        "fl1000YrRpDef": {
          "type": "number"
        },
        "fl10000YrRpDef": {
          "type": "number"
        },
        "fl50YrRpUndef": {
          "type": "number"
        },
        "fl75YrRpUndef": {
          "type": "number"
        },
        "fl100YrRpUndef": {
          "type": "number"
        },
        "fl200YrRpUndef": {
          "type": "number"
        },
        "fl250YrRpUndef": {
          "type": "number"
        },
        "fl500YrRpUndef": {
          "type": "number"
        },
        "fl1000YrRpUndef": {
          "type": "number"
        },
        "fl10000YrRpUndef": {
          "type": "number"
        },
        "hdFlMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "flFfHag": {
          "type": "number"
        },
        "flFfHagFlag": {
          "type": "number"
        },
        "flZoneGroup": {
          "type": "number"
        },
        "flPerBasement": {
          "type": "number"
        }
      }
    },
    "frDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "startDate": {
          "type": "string"
        },
        "completionDate": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "fireDepartmentRatingModifier": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "fireDepartmentRating": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "sprinklerSystem": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "remoteAlarm": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "frPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "frProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "frSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "frSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "wildFireHazard": {
          "type": "number"
        },
        "wildFireSusceptibility": {
          "type": "number"
        },
        "wildFireThreat": {
          "type": "number"
        },
        "wildFireAreaDescription": {
          "type": "number"
        },
        "wildFireSurfaceFuelType": {
          "type": "string"
        },
        "wildFireSpecialConditions": {
          "type": "string"
        },
        "wildFireLocalHistory": {
          "type": "number"
        },
        "wildFireNearbyHistory": {
          "type": "number"
        },
        "wildFireAccessibility": {
          "type": "number"
        },
        "wildFireMatch": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "isValid": {
          "type": "boolean"
        }
      }
    },
    "trDetail": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "siteLimit": {
          "type": "number"
        },
        "siteDeduct": {
          "type": "number"
        },
        "combinedLimit": {
          "type": "number"
        },
        "combinedDeduct": {
          "type": "number"
        },
        "yearUpgrade": {
          "type": "string"
        },
        "startDate": {
          "type": "string"
        },
        "completionDate": {
          "type": "string"
        },
        "percentComplete": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        },
        "trPackage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "trProtect": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "trSalvage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "trSpecieStorage": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        }
      }
    },
    "buildingAttribute": {
      "type": "object",
      "properties": {
        "buildingId": {
          "type": "string"
        },
        "buildingNumber": {
          "type": "string"
        },
        "streetPrefix": {
          "type": "string"
        },
        "streetName": {
          "type": "string"
        },
        "streetType": {
          "type": "string"
        },
        "streetSuffix": {
          "type": "string"
        },
        "cityName": {
          "type": "string"
        },
        "stateCode": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        },
        "buildingClassScheme": {
          "type": "string",
          "enum": [
            "RMS",
            "ATC",
            "ISO",
            "FIRE",
            "RMS_IND",
            "JPBLDG",
            "EURO",
            "RMS_BR",
            "RMS_OP",
            "USER"
          ]
        },
        "occupancyTypeScheme": {
          "type": "string",
          "enum": [
            "ATC",
            "SIC",
            "NAICS",
            "NCCI",
            "ISO",
            "IBC",
            "RMS_IND",
            "JPOCC",
            "EURO",
            "RMS_BR",
            "RMS_OP",
            "WOCC"
          ]
        },
        "derivedStories": {
          "type": "number"
        },
        "areaUnit": {
          "type": "string",
          "enum": [
            "SqFeet",
            "SqMeter"
          ]
        },
        "yearRange": {
          "type": "number"
        },
        "exterior": {
          "type": "string"
        },
        "fireproof": {
          "type": "string"
        },
        "esdbBuildingName": {
          "type": "string"
        },
        "esdbBuildingClass": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "esdbOccupancyType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "esdbBldgHeight": {
          "type": "number"
        },
        "esdbStories": {
          "type": "number"
        },
        "esdbSquareFootage": {
          "type": "number"
        },
        "esdbYearBuilt": {
          "type": "string"
        }
      }
    },
    "coverages": {
      "type": "array"
    },
    "reinsuranceCessions": {
      "type": "array"
    },
    "wcDetails": {
      "type": "array"
    },
    "currency": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "tiv": {
      "type": "number"
    },
    "riskAssessorCurves": {
      "type": "string"
    },
    "locationConditions": {
      "type": "array"
    },
    "esdbBuildingAttribute": {
      "type": "object",
      "properties": {
        "buildingId": {
          "type": "string"
        },
        "buildingNumber": {
          "type": "string"
        },
        "streetPrefix": {
          "type": "string"
        },
        "streetName": {
          "type": "string"
        },
        "streetType": {
          "type": "string"
        },
        "streetSuffix": {
          "type": "string"
        },
        "cityName": {
          "type": "string"
        },
        "stateCode": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        },
        "buildingClassScheme": {
          "type": "string",
          "enum": [
            "RMS",
            "ATC",
            "ISO",
            "FIRE",
            "RMS_IND",
            "JPBLDG",
            "EURO",
            "RMS_BR",
            "RMS_OP",
            "USER"
          ]
        },
        "occupancyTypeScheme": {
          "type": "string",
          "enum": [
            "ATC",
            "SIC",
            "NAICS",
            "NCCI",
            "ISO",
            "IBC",
            "RMS_IND",
            "JPOCC",
            "EURO",
            "RMS_BR",
            "RMS_OP",
            "WOCC"
          ]
        },
        "derivedStories": {
          "type": "number"
        },
        "areaUnit": {
          "type": "string",
          "enum": [
            "SqFeet",
            "SqMeter"
          ]
        },
        "yearRange": {
          "type": "number"
        },
        "exterior": {
          "type": "string"
        },
        "fireproof": {
          "type": "string"
        },
        "esdbBuildingName": {
          "type": "string"
        },
        "esdbBuildingClass": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "esdbOccupancyType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "esdbBldgHeight": {
          "type": "number"
        },
        "esdbStories": {
          "type": "number"
        },
        "esdbSquareFootage": {
          "type": "number"
        },
        "esdbYearBuilt": {
          "type": "string"
        }
      }
    },
    "maxCvgBldgValuation": {
      "type": "number"
    }
  },
  "required": [
    "property",
    "address"
  ]
}
Response  201
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Cession By Id

createLocationReinsuranceCession
POST/locations/{id}/cession{?datasource}

Creates a location reinsurance cession

Example URI

POST /api/v1/locations/id/cession?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "exposureId": 1,
  "exposureType": "POL",
  "type": "None",
  "facReinsurer": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "treaty": {
    "treatyId": 1,
    "treatyNumber": "Hello, world!",
    "treatyName": "Hello, world!",
    "cedant": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "producer": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "treatyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "currency": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "attachBasis": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "attachLevel": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "premium": 1,
    "occurLimit": 1,
    "attachPt": 1,
    "riskLimit": 1,
    "retentAmt": 1,
    "pcntPlaced": 1,
    "effectDate": "Hello, world!",
    "expireDate": "Hello, world!",
    "pcntRetent": 1,
    "pcntRiShare": 1,
    "pcntCovered": 1,
    "priority": 1,
    "numOfReinst": 1,
    "reinstCharge": 1,
    "maolAmount": 1,
    "isValid": true,
    "userId1": "Hello, world!",
    "userId2": "Hello, world!",
    "lobs": [
      {
        "id": 1,
        "name": "Hello, world!"
      }
    ]
  },
  "layerNumber": 1,
  "layerAmount": 1,
  "excessAmount": 1,
  "percentReinsurance": 1,
  "maolAmount": 1,
  "priority": 1,
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "exposureId": {
      "type": "number"
    },
    "exposureType": {
      "type": "string",
      "enum": [
        "POL",
        "LOC"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "None",
        "Facultative",
        "Treaty"
      ]
    },
    "facReinsurer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "treaty": {
      "type": "object",
      "properties": {
        "treatyId": {
          "type": "number"
        },
        "treatyNumber": {
          "type": "string"
        },
        "treatyName": {
          "type": "string"
        },
        "cedant": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "producer": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "treatyType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "currency": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "attachBasis": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "attachLevel": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "premium": {
          "type": "number"
        },
        "occurLimit": {
          "type": "number"
        },
        "attachPt": {
          "type": "number"
        },
        "riskLimit": {
          "type": "number"
        },
        "retentAmt": {
          "type": "number"
        },
        "pcntPlaced": {
          "type": "number"
        },
        "effectDate": {
          "type": "string"
        },
        "expireDate": {
          "type": "string"
        },
        "pcntRetent": {
          "type": "number"
        },
        "pcntRiShare": {
          "type": "number"
        },
        "pcntCovered": {
          "type": "number"
        },
        "priority": {
          "type": "number"
        },
        "numOfReinst": {
          "type": "number"
        },
        "reinstCharge": {
          "type": "number"
        },
        "maolAmount": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        },
        "userId1": {
          "type": "string"
        },
        "userId2": {
          "type": "string"
        },
        "lobs": {
          "type": "array"
        }
      },
      "required": [
        "cedant"
      ]
    },
    "layerNumber": {
      "type": "number"
    },
    "layerAmount": {
      "type": "number"
    },
    "excessAmount": {
      "type": "number"
    },
    "percentReinsurance": {
      "type": "number"
    },
    "maolAmount": {
      "type": "number"
    },
    "priority": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  201
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Cession By Id And Cessionid

getLocationReinsuranceCessionDetail
GET/locations/{id}/cession/{cessionid}{?datasource}

Gets ReinsuranceCession details by cession id.

Example URI

GET /api/v1/locations/id/cession/cessionid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

cessionid
number (required) 

ID number of the cession.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "exposureId": 1,
  "exposureType": "POL",
  "type": "None",
  "facReinsurer": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "treaty": {
    "treatyId": 1,
    "treatyNumber": "Hello, world!",
    "treatyName": "Hello, world!",
    "cedant": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "producer": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "treatyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "currency": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "attachBasis": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "attachLevel": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "premium": 1,
    "occurLimit": 1,
    "attachPt": 1,
    "riskLimit": 1,
    "retentAmt": 1,
    "pcntPlaced": 1,
    "effectDate": "Hello, world!",
    "expireDate": "Hello, world!",
    "pcntRetent": 1,
    "pcntRiShare": 1,
    "pcntCovered": 1,
    "priority": 1,
    "numOfReinst": 1,
    "reinstCharge": 1,
    "maolAmount": 1,
    "isValid": true,
    "userId1": "Hello, world!",
    "userId2": "Hello, world!",
    "lobs": [
      {
        "id": 1,
        "name": "Hello, world!"
      }
    ]
  },
  "layerNumber": 1,
  "layerAmount": 1,
  "excessAmount": 1,
  "percentReinsurance": 1,
  "maolAmount": 1,
  "priority": 1,
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "exposureId": {
      "type": "number"
    },
    "exposureType": {
      "type": "string",
      "enum": [
        "POL",
        "LOC"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "None",
        "Facultative",
        "Treaty"
      ]
    },
    "facReinsurer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "treaty": {
      "type": "object",
      "properties": {
        "treatyId": {
          "type": "number"
        },
        "treatyNumber": {
          "type": "string"
        },
        "treatyName": {
          "type": "string"
        },
        "cedant": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "producer": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "treatyType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "currency": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "attachBasis": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "attachLevel": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "premium": {
          "type": "number"
        },
        "occurLimit": {
          "type": "number"
        },
        "attachPt": {
          "type": "number"
        },
        "riskLimit": {
          "type": "number"
        },
        "retentAmt": {
          "type": "number"
        },
        "pcntPlaced": {
          "type": "number"
        },
        "effectDate": {
          "type": "string"
        },
        "expireDate": {
          "type": "string"
        },
        "pcntRetent": {
          "type": "number"
        },
        "pcntRiShare": {
          "type": "number"
        },
        "pcntCovered": {
          "type": "number"
        },
        "priority": {
          "type": "number"
        },
        "numOfReinst": {
          "type": "number"
        },
        "reinstCharge": {
          "type": "number"
        },
        "maolAmount": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        },
        "userId1": {
          "type": "string"
        },
        "userId2": {
          "type": "string"
        },
        "lobs": {
          "type": "array"
        }
      },
      "required": [
        "cedant"
      ]
    },
    "layerNumber": {
      "type": "number"
    },
    "layerAmount": {
      "type": "number"
    },
    "excessAmount": {
      "type": "number"
    },
    "percentReinsurance": {
      "type": "number"
    },
    "maolAmount": {
      "type": "number"
    },
    "priority": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updateLocationReinsuranceCession
PUT/locations/{id}/cession/{cessionid}{?datasource}

Updates a location reinsurance cession

Example URI

PUT /api/v1/locations/id/cession/cessionid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

cessionid
number (required) 

ID number of the cession.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "exposureId": 1,
  "exposureType": "POL",
  "type": "None",
  "facReinsurer": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "treaty": {
    "treatyId": 1,
    "treatyNumber": "Hello, world!",
    "treatyName": "Hello, world!",
    "cedant": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "producer": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "treatyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "currency": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "attachBasis": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "attachLevel": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "premium": 1,
    "occurLimit": 1,
    "attachPt": 1,
    "riskLimit": 1,
    "retentAmt": 1,
    "pcntPlaced": 1,
    "effectDate": "Hello, world!",
    "expireDate": "Hello, world!",
    "pcntRetent": 1,
    "pcntRiShare": 1,
    "pcntCovered": 1,
    "priority": 1,
    "numOfReinst": 1,
    "reinstCharge": 1,
    "maolAmount": 1,
    "isValid": true,
    "userId1": "Hello, world!",
    "userId2": "Hello, world!",
    "lobs": [
      {
        "id": 1,
        "name": "Hello, world!"
      }
    ]
  },
  "layerNumber": 1,
  "layerAmount": 1,
  "excessAmount": 1,
  "percentReinsurance": 1,
  "maolAmount": 1,
  "priority": 1,
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "exposureId": {
      "type": "number"
    },
    "exposureType": {
      "type": "string",
      "enum": [
        "POL",
        "LOC"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "None",
        "Facultative",
        "Treaty"
      ]
    },
    "facReinsurer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "treaty": {
      "type": "object",
      "properties": {
        "treatyId": {
          "type": "number"
        },
        "treatyNumber": {
          "type": "string"
        },
        "treatyName": {
          "type": "string"
        },
        "cedant": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "producer": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "treatyType": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "currency": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "attachBasis": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "attachLevel": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          }
        },
        "premium": {
          "type": "number"
        },
        "occurLimit": {
          "type": "number"
        },
        "attachPt": {
          "type": "number"
        },
        "riskLimit": {
          "type": "number"
        },
        "retentAmt": {
          "type": "number"
        },
        "pcntPlaced": {
          "type": "number"
        },
        "effectDate": {
          "type": "string"
        },
        "expireDate": {
          "type": "string"
        },
        "pcntRetent": {
          "type": "number"
        },
        "pcntRiShare": {
          "type": "number"
        },
        "pcntCovered": {
          "type": "number"
        },
        "priority": {
          "type": "number"
        },
        "numOfReinst": {
          "type": "number"
        },
        "reinstCharge": {
          "type": "number"
        },
        "maolAmount": {
          "type": "number"
        },
        "isValid": {
          "type": "boolean"
        },
        "userId1": {
          "type": "string"
        },
        "userId2": {
          "type": "string"
        },
        "lobs": {
          "type": "array"
        }
      },
      "required": [
        "cedant"
      ]
    },
    "layerNumber": {
      "type": "number"
    },
    "layerAmount": {
      "type": "number"
    },
    "excessAmount": {
      "type": "number"
    },
    "percentReinsurance": {
      "type": "number"
    },
    "maolAmount": {
      "type": "number"
    },
    "priority": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

deleteLocationReinsuranceCession
DELETE/locations/{id}/cession/{cessionid}{?datasource}

Deletes a location reinsurance cession

Example URI

DELETE /api/v1/locations/id/cession/cessionid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

cessionid
number (required) 

ID number of the cession.

datasource
string (optional) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Locationbidetail By Id

createLocationBiDetail
POST/locations/{id}/locationbidetail{?datasource}

Create a new bi detail

Example URI

POST /api/v1/locations/id/locationbidetail?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "redundancy": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "siWaitingPeriod": 1,
  "siLimit": 1,
  "preparedness": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "serviceInterruption": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "redundancy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "siWaitingPeriod": {
      "type": "number"
    },
    "siLimit": {
      "type": "number"
    },
    "preparedness": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "serviceInterruption": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  201

Locations Locationbidetail By Id

getLocationBiDetail
GET/locations/{id}/locationbidetail/{locationbidetailid}{?datasource}

Get a location bi detail

Example URI

GET /api/v1/locations/id/locationbidetail/locationbidetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationbidetailid
number (required) 

ID number of the location bi detail record.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "redundancy": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "siWaitingPeriod": 1,
  "siLimit": 1,
  "preparedness": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "serviceInterruption": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "redundancy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "siWaitingPeriod": {
      "type": "number"
    },
    "siLimit": {
      "type": "number"
    },
    "preparedness": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "serviceInterruption": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updateLocationBiDetail
PUT/locations/{id}/locationbidetail/{locationbidetailid}{?datasource}

Updates bi detail

Example URI

PUT /api/v1/locations/id/locationbidetail/locationbidetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationbidetailid
number (required) 

ID number of the location bi detail record.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "redundancy": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "siWaitingPeriod": 1,
  "siLimit": 1,
  "preparedness": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "serviceInterruption": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "redundancy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "siWaitingPeriod": {
      "type": "number"
    },
    "siLimit": {
      "type": "number"
    },
    "preparedness": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "serviceInterruption": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  204
Response  404
HideShow

Not found. The resource referenced does not exist.

Headers
Content-Type: application/json
Body
{
  "links": [
    {
      "rel": "Hello, world!",
      "href": "Hello, world!",
      "method": "Hello, world!"
    }
  ],
  "meta": {
    "createdBy": "Hello, world!",
    "createdAt": "Hello, world!",
    "updatedBy": "Hello, world!",
    "updatedAt": "Hello, world!",
    "count": 1
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "links": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        },
        "updatedBy": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        },
        "count": {
          "type": "number"
        }
      }
    }
  },
  "required": [
    "links",
    "meta"
  ]
}

deleteLocationBiDetail
DELETE/locations/{id}/locationbidetail/{locationbidetailid}{?datasource}

Deletes a location bi detail

Example URI

DELETE /api/v1/locations/id/locationbidetail/locationbidetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationbidetailid
number (required) 

ID number of the location bi detail record.

datasource
string (optional) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Coverage By Id

createLocationCoverage
POST/locations/{id}/coverage{?datasource}

Create a new coverage

Example URI

POST /api/v1/locations/id/coverage?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "waitingPeriod": 1,
  "id": 1,
  "label": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqslModifier": 1,
  "lossType": "Building",
  "percentSprinkler": 1,
  "value": 1,
  "biPoi": 1,
  "deductible": 1,
  "coverageModifier": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "accumulation": "Building",
  "limit": 1,
  "peril": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "waitingPeriod": {
      "type": "number"
    },
    "id": {
      "type": "number"
    },
    "label": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqslModifier": {
      "type": "number"
    },
    "lossType": {
      "type": "string",
      "enum": [
        "Building",
        "Contents",
        "BI",
        "CombinedCvg"
      ]
    },
    "percentSprinkler": {
      "type": "number"
    },
    "value": {
      "type": "number"
    },
    "biPoi": {
      "type": "number"
    },
    "deductible": {
      "type": "number"
    },
    "coverageModifier": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "accumulation": {
      "type": "string",
      "enum": [
        "Building",
        "Contents",
        "Bi",
        "Combined"
      ]
    },
    "limit": {
      "type": "number"
    },
    "peril": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  201

Locations Coverage By Id And Coverageid

getLocationCoverage
GET/locations/{id}/coverage/{coverageid}{?datasource}

Gets a location coverage

Example URI

GET /api/v1/locations/id/coverage/coverageid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

coverageid
number (required) 

ID number of the location coverage record.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK

Headers
Content-Type: application/json
Body
{
  "waitingPeriod": 1,
  "id": 1,
  "label": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqslModifier": 1,
  "lossType": "Building",
  "percentSprinkler": 1,
  "value": 1,
  "biPoi": 1,
  "deductible": 1,
  "coverageModifier": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "accumulation": "Building",
  "limit": 1,
  "peril": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "waitingPeriod": {
      "type": "number"
    },
    "id": {
      "type": "number"
    },
    "label": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqslModifier": {
      "type": "number"
    },
    "lossType": {
      "type": "string",
      "enum": [
        "Building",
        "Contents",
        "BI",
        "CombinedCvg"
      ]
    },
    "percentSprinkler": {
      "type": "number"
    },
    "value": {
      "type": "number"
    },
    "biPoi": {
      "type": "number"
    },
    "deductible": {
      "type": "number"
    },
    "coverageModifier": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "accumulation": {
      "type": "string",
      "enum": [
        "Building",
        "Contents",
        "Bi",
        "Combined"
      ]
    },
    "limit": {
      "type": "number"
    },
    "peril": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updateLocationCoverage
PUT/locations/{id}/coverage/{coverageid}{?datasource}

Updates coverage

Example URI

PUT /api/v1/locations/id/coverage/coverageid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

coverageid
number (required) 

ID number of the location coverage record.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "waitingPeriod": 1,
  "id": 1,
  "label": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "eqslModifier": 1,
  "lossType": "Building",
  "percentSprinkler": 1,
  "value": 1,
  "biPoi": 1,
  "deductible": 1,
  "coverageModifier": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "accumulation": "Building",
  "limit": 1,
  "peril": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "isValid": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "waitingPeriod": {
      "type": "number"
    },
    "id": {
      "type": "number"
    },
    "label": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "eqslModifier": {
      "type": "number"
    },
    "lossType": {
      "type": "string",
      "enum": [
        "Building",
        "Contents",
        "BI",
        "CombinedCvg"
      ]
    },
    "percentSprinkler": {
      "type": "number"
    },
    "value": {
      "type": "number"
    },
    "biPoi": {
      "type": "number"
    },
    "deductible": {
      "type": "number"
    },
    "coverageModifier": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "accumulation": {
      "type": "string",
      "enum": [
        "Building",
        "Contents",
        "Bi",
        "Combined"
      ]
    },
    "limit": {
      "type": "number"
    },
    "peril": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "isValid": {
      "type": "boolean"
    }
  }
}
Response  204
Response  404
HideShow

Not found. The resource referenced does not exist.

Headers
Content-Type: application/json
Body
{
  "links": [
    {
      "rel": "Hello, world!",
      "href": "Hello, world!",
      "method": "Hello, world!"
    }
  ],
  "meta": {
    "createdBy": "Hello, world!",
    "createdAt": "Hello, world!",
    "updatedBy": "Hello, world!",
    "updatedAt": "Hello, world!",
    "count": 1
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "links": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        },
        "updatedBy": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        },
        "count": {
          "type": "number"
        }
      }
    }
  },
  "required": [
    "links",
    "meta"
  ]
}

deleteLocationCoverage
DELETE/locations/{id}/coverage/{coverageid}{?datasource}

Deletes a location coverage

Example URI

DELETE /api/v1/locations/id/coverage/coverageid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

coverageid
number (required) 

ID number of the location coverage record.

datasource
string (optional) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Locationwsdetail By Id

createLocationWsDetail
POST/locations/{id}/locationwsdetail{?datasource}

Creates a location ws details

Example URI

POST /api/v1/locations/id/locationwsdetail?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "yearUpgrade": "Hello, world!",
  "startDate": "Hello, world!",
  "completionDate": "Hello, world!",
  "percentComplete": 1,
  "coastalSegment": "Hello, world!",
  "fireClass": "Hello, world!",
  "rmsClass": "Hello, world!",
  "userClass": "Hello, world!",
  "atcOccupancy": "Hello, world!",
  "isoOccupancy": "Hello, world!",
  "sicOccupancy": "Hello, world!",
  "ibcOccupancy": "Hello, world!",
  "userOccupancy": "Hello, world!",
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "isValid": true,
  "architecture": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladRate": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "constructQuality": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "designCode": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "doorOpenings": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "externalOrnament": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodVulnerability": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "foundation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "maintenance": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecSide": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "otherOpenings": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofAge": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofAnchor": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofEquipment": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofFrame": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofGeometry": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofParpet": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofSystem": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windMissile": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windVulnerability": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodMissiles": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodProtection": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "basement": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecGround": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flashing": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ifmVerticalExpDist": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ifmStructCondition": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ifmEquipBracing": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ifmMissileExp": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "resistGarage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsFloorType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsFoundationType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodIndex": 1,
  "distToCoast": 1,
  "sysDistToCoast": 1,
  "elevation": 1,
  "manMadeCov": 1,
  "naturalCov": 1,
  "elevationCov": 1,
  "distToCoastCov": 1,
  "manMadeRoughness": 1,
  "naturalRoughness": 1,
  "windPool": 1,
  "biZone": 1,
  "topologyFeature": 1,
  "elevationMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "naturalRoughnessMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "manMadeRoughnessMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "distToCoastMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windPoolMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windExposure": 1,
  "nfipRate": 1,
  "nfipYear": 1,
  "nfipYearMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "buildingElevation": 1,
  "buildingElevationMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "rmsBuildingElevation": 1,
  "rmsBuildingElevationMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "zoneGroup": 1,
  "perBasement": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "completionDate": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "coastalSegment": {
      "type": "string"
    },
    "fireClass": {
      "type": "string"
    },
    "rmsClass": {
      "type": "string"
    },
    "userClass": {
      "type": "string"
    },
    "atcOccupancy": {
      "type": "string"
    },
    "isoOccupancy": {
      "type": "string"
    },
    "sicOccupancy": {
      "type": "string"
    },
    "ibcOccupancy": {
      "type": "string"
    },
    "userOccupancy": {
      "type": "string"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    },
    "architecture": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladRate": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "constructQuality": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "designCode": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "doorOpenings": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "externalOrnament": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodVulnerability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "foundation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "maintenance": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecSide": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "otherOpenings": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofAge": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofAnchor": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofEquipment": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofFrame": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofGeometry": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofParpet": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofSystem": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windMissile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windVulnerability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodMissiles": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodProtection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "basement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecGround": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flashing": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ifmVerticalExpDist": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ifmStructCondition": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ifmEquipBracing": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ifmMissileExp": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "resistGarage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsFloorType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsFoundationType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodIndex": {
      "type": "number"
    },
    "distToCoast": {
      "type": "number"
    },
    "sysDistToCoast": {
      "type": "number"
    },
    "elevation": {
      "type": "number"
    },
    "manMadeCov": {
      "type": "number"
    },
    "naturalCov": {
      "type": "number"
    },
    "elevationCov": {
      "type": "number"
    },
    "distToCoastCov": {
      "type": "number"
    },
    "manMadeRoughness": {
      "type": "number"
    },
    "naturalRoughness": {
      "type": "number"
    },
    "windPool": {
      "type": "number"
    },
    "biZone": {
      "type": "number"
    },
    "topologyFeature": {
      "type": "number"
    },
    "elevationMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "naturalRoughnessMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "manMadeRoughnessMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "distToCoastMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windPoolMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windExposure": {
      "type": "number"
    },
    "nfipRate": {
      "type": "number"
    },
    "nfipYear": {
      "type": "number"
    },
    "nfipYearMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "buildingElevation": {
      "type": "number"
    },
    "buildingElevationMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "rmsBuildingElevation": {
      "type": "number"
    },
    "rmsBuildingElevationMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "zoneGroup": {
      "type": "number"
    },
    "perBasement": {
      "type": "number"
    }
  }
}
Response  201
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Locationwsdetail By Id

getLocationWsDetail
GET/locations/{id}/locationwsdetail/{locationwsdetailid}{?datasource}

Gets a location WS detail

Example URI

GET /api/v1/locations/id/locationwsdetail/locationwsdetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationwsdetailid
number (required) 

ID number of the location windstorm record.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "yearUpgrade": "Hello, world!",
  "startDate": "Hello, world!",
  "completionDate": "Hello, world!",
  "percentComplete": 1,
  "coastalSegment": "Hello, world!",
  "fireClass": "Hello, world!",
  "rmsClass": "Hello, world!",
  "userClass": "Hello, world!",
  "atcOccupancy": "Hello, world!",
  "isoOccupancy": "Hello, world!",
  "sicOccupancy": "Hello, world!",
  "ibcOccupancy": "Hello, world!",
  "userOccupancy": "Hello, world!",
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "isValid": true,
  "architecture": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladRate": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "constructQuality": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "designCode": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "doorOpenings": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "externalOrnament": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodVulnerability": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "foundation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "maintenance": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecSide": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "otherOpenings": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofAge": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofAnchor": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofEquipment": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofFrame": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofGeometry": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofParpet": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofSystem": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windMissile": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windVulnerability": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodMissiles": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodProtection": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "basement": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecGround": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flashing": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ifmVerticalExpDist": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ifmStructCondition": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ifmEquipBracing": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ifmMissileExp": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "resistGarage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsFloorType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsFoundationType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodIndex": 1,
  "distToCoast": 1,
  "sysDistToCoast": 1,
  "elevation": 1,
  "manMadeCov": 1,
  "naturalCov": 1,
  "elevationCov": 1,
  "distToCoastCov": 1,
  "manMadeRoughness": 1,
  "naturalRoughness": 1,
  "windPool": 1,
  "biZone": 1,
  "topologyFeature": 1,
  "elevationMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "naturalRoughnessMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "manMadeRoughnessMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "distToCoastMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windPoolMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windExposure": 1,
  "nfipRate": 1,
  "nfipYear": 1,
  "nfipYearMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "buildingElevation": 1,
  "buildingElevationMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "rmsBuildingElevation": 1,
  "rmsBuildingElevationMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "zoneGroup": 1,
  "perBasement": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "completionDate": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "coastalSegment": {
      "type": "string"
    },
    "fireClass": {
      "type": "string"
    },
    "rmsClass": {
      "type": "string"
    },
    "userClass": {
      "type": "string"
    },
    "atcOccupancy": {
      "type": "string"
    },
    "isoOccupancy": {
      "type": "string"
    },
    "sicOccupancy": {
      "type": "string"
    },
    "ibcOccupancy": {
      "type": "string"
    },
    "userOccupancy": {
      "type": "string"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    },
    "architecture": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladRate": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "constructQuality": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "designCode": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "doorOpenings": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "externalOrnament": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodVulnerability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "foundation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "maintenance": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecSide": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "otherOpenings": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofAge": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofAnchor": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofEquipment": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofFrame": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofGeometry": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofParpet": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofSystem": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windMissile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windVulnerability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodMissiles": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodProtection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "basement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecGround": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flashing": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ifmVerticalExpDist": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ifmStructCondition": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ifmEquipBracing": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ifmMissileExp": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "resistGarage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsFloorType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsFoundationType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodIndex": {
      "type": "number"
    },
    "distToCoast": {
      "type": "number"
    },
    "sysDistToCoast": {
      "type": "number"
    },
    "elevation": {
      "type": "number"
    },
    "manMadeCov": {
      "type": "number"
    },
    "naturalCov": {
      "type": "number"
    },
    "elevationCov": {
      "type": "number"
    },
    "distToCoastCov": {
      "type": "number"
    },
    "manMadeRoughness": {
      "type": "number"
    },
    "naturalRoughness": {
      "type": "number"
    },
    "windPool": {
      "type": "number"
    },
    "biZone": {
      "type": "number"
    },
    "topologyFeature": {
      "type": "number"
    },
    "elevationMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "naturalRoughnessMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "manMadeRoughnessMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "distToCoastMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windPoolMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windExposure": {
      "type": "number"
    },
    "nfipRate": {
      "type": "number"
    },
    "nfipYear": {
      "type": "number"
    },
    "nfipYearMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "buildingElevation": {
      "type": "number"
    },
    "buildingElevationMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "rmsBuildingElevation": {
      "type": "number"
    },
    "rmsBuildingElevationMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "zoneGroup": {
      "type": "number"
    },
    "perBasement": {
      "type": "number"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updateLocationWsDetail
PUT/locations/{id}/locationwsdetail/{locationwsdetailid}{?datasource}

Updates a location ws detail

Example URI

PUT /api/v1/locations/id/locationwsdetail/locationwsdetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationwsdetailid
number (required) 

ID number of the location windstorm record.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "yearUpgrade": "Hello, world!",
  "startDate": "Hello, world!",
  "completionDate": "Hello, world!",
  "percentComplete": 1,
  "coastalSegment": "Hello, world!",
  "fireClass": "Hello, world!",
  "rmsClass": "Hello, world!",
  "userClass": "Hello, world!",
  "atcOccupancy": "Hello, world!",
  "isoOccupancy": "Hello, world!",
  "sicOccupancy": "Hello, world!",
  "ibcOccupancy": "Hello, world!",
  "userOccupancy": "Hello, world!",
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "isValid": true,
  "architecture": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladRate": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "cladType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "constructQuality": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "designCode": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "doorOpenings": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "externalOrnament": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodVulnerability": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "foundation": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "maintenance": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecSide": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "otherOpenings": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofAge": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofAnchor": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofEquipment": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofFrame": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofGeometry": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofParpet": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "roofSystem": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windMissile": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windVulnerability": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodMissiles": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodProtection": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "basement": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "mechElecGround": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "flashing": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ifmVerticalExpDist": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ifmStructCondition": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ifmEquipBracing": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "ifmMissileExp": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "resistGarage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsFloorType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wsFoundationType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "floodIndex": 1,
  "distToCoast": 1,
  "sysDistToCoast": 1,
  "elevation": 1,
  "manMadeCov": 1,
  "naturalCov": 1,
  "elevationCov": 1,
  "distToCoastCov": 1,
  "manMadeRoughness": 1,
  "naturalRoughness": 1,
  "windPool": 1,
  "biZone": 1,
  "topologyFeature": 1,
  "elevationMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "naturalRoughnessMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "manMadeRoughnessMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "distToCoastMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windPoolMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "windExposure": 1,
  "nfipRate": 1,
  "nfipYear": 1,
  "nfipYearMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "buildingElevation": 1,
  "buildingElevationMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "rmsBuildingElevation": 1,
  "rmsBuildingElevationMatch": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "zoneGroup": 1,
  "perBasement": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "completionDate": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "coastalSegment": {
      "type": "string"
    },
    "fireClass": {
      "type": "string"
    },
    "rmsClass": {
      "type": "string"
    },
    "userClass": {
      "type": "string"
    },
    "atcOccupancy": {
      "type": "string"
    },
    "isoOccupancy": {
      "type": "string"
    },
    "sicOccupancy": {
      "type": "string"
    },
    "ibcOccupancy": {
      "type": "string"
    },
    "userOccupancy": {
      "type": "string"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    },
    "architecture": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladRate": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "cladType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "constructQuality": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "designCode": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "doorOpenings": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "externalOrnament": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodVulnerability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "foundation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "maintenance": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecSide": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "otherOpenings": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofAge": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofAnchor": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofEquipment": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofFrame": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofGeometry": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofParpet": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "roofSystem": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windMissile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windVulnerability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodMissiles": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodProtection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "basement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "mechElecGround": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "flashing": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ifmVerticalExpDist": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ifmStructCondition": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ifmEquipBracing": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "ifmMissileExp": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "resistGarage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsFloorType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wsFoundationType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "floodIndex": {
      "type": "number"
    },
    "distToCoast": {
      "type": "number"
    },
    "sysDistToCoast": {
      "type": "number"
    },
    "elevation": {
      "type": "number"
    },
    "manMadeCov": {
      "type": "number"
    },
    "naturalCov": {
      "type": "number"
    },
    "elevationCov": {
      "type": "number"
    },
    "distToCoastCov": {
      "type": "number"
    },
    "manMadeRoughness": {
      "type": "number"
    },
    "naturalRoughness": {
      "type": "number"
    },
    "windPool": {
      "type": "number"
    },
    "biZone": {
      "type": "number"
    },
    "topologyFeature": {
      "type": "number"
    },
    "elevationMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "naturalRoughnessMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "manMadeRoughnessMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "distToCoastMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windPoolMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "windExposure": {
      "type": "number"
    },
    "nfipRate": {
      "type": "number"
    },
    "nfipYear": {
      "type": "number"
    },
    "nfipYearMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "buildingElevation": {
      "type": "number"
    },
    "buildingElevationMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "rmsBuildingElevation": {
      "type": "number"
    },
    "rmsBuildingElevationMatch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "zoneGroup": {
      "type": "number"
    },
    "perBasement": {
      "type": "number"
    }
  }
}
Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

deleteLocationWsDetail
DELETE/locations/{id}/locationwsdetail/{locationwsdetailid}{?datasource}

Deletes a location ws detail

Example URI

DELETE /api/v1/locations/id/locationwsdetail/locationwsdetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationwsdetailid
number (required) 

ID number of the location windstorm record.

datasource
string (optional) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Locationtrdetail By Id

createLocationTrDetail
POST/locations/{id}/locationtrdetail{?datasource}

Creates a location tr details

Example URI

POST /api/v1/locations/id/locationtrdetail?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "yearUpgrade": "Hello, world!",
  "startDate": "Hello, world!",
  "completionDate": "Hello, world!",
  "percentComplete": 1,
  "isValid": true,
  "trPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "trProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "trSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "trSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "completionDate": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    },
    "trPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "trProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "trSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "trSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}
Response  201
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Locationtrdetail By Id

getLocationTrDetail
GET/locations/{id}/locationtrdetail/{locationtrdetailid}{?datasource}

Gets a location TR detail

Example URI

GET /api/v1/locations/id/locationtrdetail/locationtrdetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationtrdetailid
number (required) 

ID number of the location terrorism record.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "yearUpgrade": "Hello, world!",
  "startDate": "Hello, world!",
  "completionDate": "Hello, world!",
  "percentComplete": 1,
  "isValid": true,
  "trPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "trProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "trSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "trSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "completionDate": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    },
    "trPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "trProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "trSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "trSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updateLocationTrDetail
PUT/locations/{id}/locationtrdetail/{locationtrdetailid}{?datasource}

Updates a location tr detail

Example URI

PUT /api/v1/locations/id/locationtrdetail/locationtrdetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationtrdetailid
number (required) 

ID number of the location terrorism record.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "siteLimit": 1,
  "siteDeduct": 1,
  "combinedLimit": 1,
  "combinedDeduct": 1,
  "yearUpgrade": "Hello, world!",
  "startDate": "Hello, world!",
  "completionDate": "Hello, world!",
  "percentComplete": 1,
  "isValid": true,
  "trPackage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "trProtect": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "trSalvage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "trSpecieStorage": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "siteLimit": {
      "type": "number"
    },
    "siteDeduct": {
      "type": "number"
    },
    "combinedLimit": {
      "type": "number"
    },
    "combinedDeduct": {
      "type": "number"
    },
    "yearUpgrade": {
      "type": "string"
    },
    "startDate": {
      "type": "string"
    },
    "completionDate": {
      "type": "string"
    },
    "percentComplete": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    },
    "trPackage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "trProtect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "trSalvage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "trSpecieStorage": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}
Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

deleteLocationTrDetail
DELETE/locations/{id}/locationtrdetail/{locationtrdetailid}{?datasource}

Deletes a location tr detail

Example URI

DELETE /api/v1/locations/id/locationtrdetail/locationtrdetailid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

locationtrdetailid
number (required) 

ID number of the location terrorism record.

datasource
string (optional) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Locations Locationwcdetail By Id

createLocationWcDetail
POST/locations/{id}/locationwcdetail{?datasource}

Creates a location wc details

Example URI

POST /api/v1/locations/id/locationwcdetail?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "totalPayroll": 1,
  "totalNumEmployees": 1,
  "numEmployeesShift1": 1,
  "numEmployeesShift2": 1,
  "numEmployeesShift3": 1,
  "numEmployeesShift4": 1,
  "calcNumEmployees": 1,
  "emergencyProtection": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "hazardousMaterials": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "wageRelativity": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "riskManagement": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "employeeDensity": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "undMngtAdjustment": 1,
  "groupNum": "Hello, world!",
  "groupName": "Hello, world!",
  "occupancyTypeScheme": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "occupancyType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "maxEmployees": 1,
  "shiftType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "isValid": true,
  "uslh": true,
  "excessComp": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "totalPayroll": {
      "type": "number"
    },
    "totalNumEmployees": {
      "type": "number"
    },
    "numEmployeesShift1": {
      "type": "number"
    },
    "numEmployeesShift2": {
      "type": "number"
    },
    "numEmployeesShift3": {
      "type": "number"
    },
    "numEmployeesShift4": {
      "type": "number"
    },
    "calcNumEmployees": {
      "type": "number"
    },
    "emergencyProtection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "hazardousMaterials": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "wageRelativity": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "riskManagement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "employeeDensity": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "undMngtAdjustment": {
      "type": "number"
    },
    "groupNum": {
      "type": "string"
    },
    "groupName": {
      "type": "string"
    },
    "occupancyTypeScheme": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "occupancyType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "maxEmployees": {
      "type": "number"
    },
    "shiftType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "isValid": {
      "type": "boolean"
    },
    "uslh": {
      "type": "boolean"
    },
    "excessComp": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}
Response  201
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Producer

Producers

getProducers
GET/producers{?datasource,q,sort,limit,offset}

Retrieves a list of the producers in a specified data source.

Example URI

GET /api/v1/producers?datasource=&q=&sort=&limit=&offset=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

q
string (optional) 

Filters applied to the query results.

sort
string (optional) 

Specify comma-delimited field names followed by ‘ASC’ (to display the results in alphabetical or numerical ascending order) or ‘DESC’ (to display the results in descending order.)

limit
number (optional) 

Maximum number of retrieved records to display on the page.

offset
number (optional) 

Number of the page displaying the returned records, starting at ‘0’.

Response  200
HideShow

OK. List of producers in the data source is successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "searchTotalMatch": 1,
  "searchItems": [
    {
      "id": "Hello, world!",
      "name": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "searchTotalMatch": {
      "type": "number"
    },
    "searchItems": {
      "type": "array"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Producers

createProducer
POST/producers{?datasource}

Creates new Producer in a specified data source.

Example URI

POST /api/v1/producers?datasource=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "Hello, world!",
  "name": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  201
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  409
HideShow

Conflict. Resource already exists.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Producers By Id

getProducerById
GET/producers/{id}{?datasource}

Retrieves a Producer by id in a specified data source.

Example URI

GET /api/v1/producers/id?datasource=
URI Parameters
HideShow
id
string (required) 

ID of the Producer.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

OK. Producer by Id in the data source is successfully retrieved.

Headers
Content-Type: application/json
Body
{
  "id": "Hello, world!",
  "name": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  404
HideShow

Not found Request. resource not found.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

updateProducer
PUT/producers/{id}{?datasource}

Updates existing Producer in a specified data source.

Example URI

PUT /api/v1/producers/id?datasource=
URI Parameters
HideShow
id
string (required) 

ID of the Producer.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "Hello, world!",
  "name": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  404
HideShow

Not found Request. resource not found.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

deleteProducer
DELETE/producers/{id}{?datasource}

Deletes existing Producer in a specified data source.

Example URI

DELETE /api/v1/producers/id?datasource=
URI Parameters
HideShow
id
string (required) 

ID of the Producer.

datasource
string (optional) 

Name of the data source.

Response  204
Response  400
HideShow

Bad Request. The input data is invalid.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  403
HideShow

Forbidden. Cannot access.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  404
HideShow

Not found Request. resource not found.

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}
Response  500
HideShow

ERROR:Internal Server Error

Headers
Content-Type: application/json
Body
{
  "code": "Hello, world!",
  "message": "Hello, world!",
  "logId": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logId": {
      "type": "string"
    }
  }
}

Treaty

Treaties By Id

getTreaty
GET/treaties/{id}{?datasource}

Retrieve a treaty in a specified data source.

Example URI

GET /api/v1/treaties/id?datasource=
URI Parameters
HideShow
id
number (required) 

Treaty Id.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

Treaty retrieved.

Headers
Content-Type: application/json
Body
{
  "treatyId": 1,
  "treatyNumber": "Hello, world!",
  "treatyName": "Hello, world!",
  "cedant": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "producer": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "treatyType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "currency": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "attachBasis": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "attachLevel": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "premium": 1,
  "occurLimit": 1,
  "attachPt": 1,
  "riskLimit": 1,
  "retentAmt": 1,
  "pcntPlaced": 1,
  "effectDate": "Hello, world!",
  "expireDate": "Hello, world!",
  "pcntRetent": 1,
  "pcntRiShare": 1,
  "pcntCovered": 1,
  "priority": 1,
  "numOfReinst": 1,
  "reinstCharge": 1,
  "maolAmount": 1,
  "isValid": true,
  "userId1": "Hello, world!",
  "userId2": "Hello, world!",
  "lobs": [
    {
      "id": 1,
      "name": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "treatyId": {
      "type": "number"
    },
    "treatyNumber": {
      "type": "string"
    },
    "treatyName": {
      "type": "string"
    },
    "cedant": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "producer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "treatyType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "currency": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "attachBasis": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "attachLevel": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "premium": {
      "type": "number"
    },
    "occurLimit": {
      "type": "number"
    },
    "attachPt": {
      "type": "number"
    },
    "riskLimit": {
      "type": "number"
    },
    "retentAmt": {
      "type": "number"
    },
    "pcntPlaced": {
      "type": "number"
    },
    "effectDate": {
      "type": "string"
    },
    "expireDate": {
      "type": "string"
    },
    "pcntRetent": {
      "type": "number"
    },
    "pcntRiShare": {
      "type": "number"
    },
    "pcntCovered": {
      "type": "number"
    },
    "priority": {
      "type": "number"
    },
    "numOfReinst": {
      "type": "number"
    },
    "reinstCharge": {
      "type": "number"
    },
    "maolAmount": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    },
    "userId1": {
      "type": "string"
    },
    "userId2": {
      "type": "string"
    },
    "lobs": {
      "type": "array"
    }
  },
  "required": [
    "cedant"
  ]
}

updateTreaty
PUT/treaties/{id}{?datasource}

Update a treaty

Example URI

PUT /api/v1/treaties/id?datasource=
URI Parameters
HideShow
id
number (required) 

Treaty Id.

datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "treatyId": 1,
  "treatyNumber": "Hello, world!",
  "treatyName": "Hello, world!",
  "cedant": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "producer": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "treatyType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "currency": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "attachBasis": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "attachLevel": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "premium": 1,
  "occurLimit": 1,
  "attachPt": 1,
  "riskLimit": 1,
  "retentAmt": 1,
  "pcntPlaced": 1,
  "effectDate": "Hello, world!",
  "expireDate": "Hello, world!",
  "pcntRetent": 1,
  "pcntRiShare": 1,
  "pcntCovered": 1,
  "priority": 1,
  "numOfReinst": 1,
  "reinstCharge": 1,
  "maolAmount": 1,
  "isValid": true,
  "userId1": "Hello, world!",
  "userId2": "Hello, world!",
  "lobs": [
    {
      "id": 1,
      "name": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "treatyId": {
      "type": "number"
    },
    "treatyNumber": {
      "type": "string"
    },
    "treatyName": {
      "type": "string"
    },
    "cedant": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "producer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "treatyType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "currency": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "attachBasis": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "attachLevel": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "premium": {
      "type": "number"
    },
    "occurLimit": {
      "type": "number"
    },
    "attachPt": {
      "type": "number"
    },
    "riskLimit": {
      "type": "number"
    },
    "retentAmt": {
      "type": "number"
    },
    "pcntPlaced": {
      "type": "number"
    },
    "effectDate": {
      "type": "string"
    },
    "expireDate": {
      "type": "string"
    },
    "pcntRetent": {
      "type": "number"
    },
    "pcntRiShare": {
      "type": "number"
    },
    "pcntCovered": {
      "type": "number"
    },
    "priority": {
      "type": "number"
    },
    "numOfReinst": {
      "type": "number"
    },
    "reinstCharge": {
      "type": "number"
    },
    "maolAmount": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    },
    "userId1": {
      "type": "string"
    },
    "userId2": {
      "type": "string"
    },
    "lobs": {
      "type": "array"
    }
  },
  "required": [
    "cedant"
  ]
}
Response  204

deleteTreaty
DELETE/treaties/{id}{?datasource}

Delete a treaty

Example URI

DELETE /api/v1/treaties/id?datasource=
URI Parameters
HideShow
id
number (required) 

Treaty Id.

datasource
string (optional) 

Name of the data source.

Response  204

Treaties

getTreatiesByFilters
GET/treaties{?datasource,q,sort,limit,offset}

Get list of Treaties with optional filters.

Example URI

GET /api/v1/treaties?datasource=&q=&sort=&limit=&offset=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

q
string (optional) 

Filters applied to the query results.

sort
string (optional) 

Specify comma-delimited field names followed by ‘ASC’ (to display the results in alphabetical or numerical ascending order) or ‘DESC’ (to display the results in descending order.)

limit
number (optional) 

Maximum number of retrieved records to display on the page.

offset
number (optional) 

Number of the page displaying the returned records, starting at ‘0’.

Response  200
HideShow

List of treaties retrieved.

Headers
Content-Type: application/json
Body
{
  "totalMatchCount": 1,
  "searchMatchingTreatyList": [
    {
      "treatyId": 1,
      "treatyNumber": "Hello, world!",
      "treatyName": "Hello, world!",
      "cedant": {
        "id": "Hello, world!",
        "name": "Hello, world!"
      },
      "producer": {
        "id": "Hello, world!",
        "name": "Hello, world!"
      },
      "treatyType": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "currency": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "attachBasis": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "attachLevel": {
        "id": 1,
        "code": "Hello, world!",
        "name": "Hello, world!"
      },
      "premium": 1,
      "occurLimit": 1,
      "attachPt": 1,
      "riskLimit": 1,
      "retentAmt": 1,
      "pcntPlaced": 1,
      "effectDate": "Hello, world!",
      "expireDate": "Hello, world!",
      "pcntRetent": 1,
      "pcntRiShare": 1,
      "pcntCovered": 1,
      "priority": 1,
      "numOfReinst": 1,
      "reinstCharge": 1,
      "maolAmount": 1,
      "isValid": true,
      "userId1": "Hello, world!",
      "userId2": "Hello, world!",
      "lobs": [
        {
          "id": 1,
          "name": "Hello, world!"
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalMatchCount": {
      "type": "number"
    },
    "searchMatchingTreatyList": {
      "type": "array"
    }
  }
}

Treaties

createTreaty
POST/treaties{?datasource}

Returns the URL location of the created Treaty resource

Example URI

POST /api/v1/treaties?datasource=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "treatyId": 1,
  "treatyNumber": "Hello, world!",
  "treatyName": "Hello, world!",
  "cedant": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "producer": {
    "id": "Hello, world!",
    "name": "Hello, world!"
  },
  "treatyType": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "currency": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "attachBasis": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "attachLevel": {
    "id": 1,
    "code": "Hello, world!",
    "name": "Hello, world!"
  },
  "premium": 1,
  "occurLimit": 1,
  "attachPt": 1,
  "riskLimit": 1,
  "retentAmt": 1,
  "pcntPlaced": 1,
  "effectDate": "Hello, world!",
  "expireDate": "Hello, world!",
  "pcntRetent": 1,
  "pcntRiShare": 1,
  "pcntCovered": 1,
  "priority": 1,
  "numOfReinst": 1,
  "reinstCharge": 1,
  "maolAmount": 1,
  "isValid": true,
  "userId1": "Hello, world!",
  "userId2": "Hello, world!",
  "lobs": [
    {
      "id": 1,
      "name": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "treatyId": {
      "type": "number"
    },
    "treatyNumber": {
      "type": "string"
    },
    "treatyName": {
      "type": "string"
    },
    "cedant": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "producer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "treatyType": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "currency": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "attachBasis": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "attachLevel": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "premium": {
      "type": "number"
    },
    "occurLimit": {
      "type": "number"
    },
    "attachPt": {
      "type": "number"
    },
    "riskLimit": {
      "type": "number"
    },
    "retentAmt": {
      "type": "number"
    },
    "pcntPlaced": {
      "type": "number"
    },
    "effectDate": {
      "type": "string"
    },
    "expireDate": {
      "type": "string"
    },
    "pcntRetent": {
      "type": "number"
    },
    "pcntRiShare": {
      "type": "number"
    },
    "pcntCovered": {
      "type": "number"
    },
    "priority": {
      "type": "number"
    },
    "numOfReinst": {
      "type": "number"
    },
    "reinstCharge": {
      "type": "number"
    },
    "maolAmount": {
      "type": "number"
    },
    "isValid": {
      "type": "boolean"
    },
    "userId1": {
      "type": "string"
    },
    "userId2": {
      "type": "string"
    },
    "lobs": {
      "type": "array"
    }
  },
  "required": [
    "cedant"
  ]
}
Response  201

Treaties Lob By Id

createTreatyLob
POST/treaties/{id}/lob{?datasource}

Creates a location treaty line of business

Example URI

POST /api/v1/treaties/id/lob?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the location.

datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    }
  }
}
Response  201

Treaties Lob By Id And Lobid

getTreatyLob
GET/treaties/{id}/lob/{lobid}{?datasource}

Gets a treaty line of business

Example URI

GET /api/v1/treaties/id/lob/lobid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the treaty.

lobid
number (required) 

ID number of the lob.

datasource
string (optional) 

Name of the data source.

Response  200
HideShow

Treaty line of business retrieved.

Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    }
  }
}

deleteTreatyLob
DELETE/treaties/{id}/lob/{lobid}{?datasource}

Deletes a treaty line of business

Example URI

DELETE /api/v1/treaties/id/lob/lobid?datasource=
URI Parameters
HideShow
id
number (required) 

ID number of the treaty.

lobid
number (required) 

ID number of the lob.

datasource
string (optional) 

Name of the data source.

Response  204

Treaties Lob Batch

batchProcessTreatyLobs
POST/treaties/lob/batch{?datasource}

Runs creating/deleting treaty lobs in a batch.

Example URI

POST /api/v1/treaties/lob/batch?datasource=
URI Parameters
HideShow
datasource
string (required) 

Name of the data source.

Request
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "method": "Hello, world!",
    "path": "Hello, world!",
    "body": "Hello, world!"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  200
HideShow

Treaty batch executed.

Headers
Content-Type: application/json
Body
[
  {
    "headers": {},
    "statusInfo": {
      "family": "INFORMATIONAL"
    },
    "metadata": {},
    "allowedMethods": [],
    "cookies": {},
    "links": [
      {
        "rels": []
      }
    ],
    "mediaType": {},
    "entityTag": {},
    "stringHeaders": {},
    "language": {
      "extensionKeys": [],
      "unicodeLocaleAttributes": [],
      "unicodeLocaleKeys": []
    }
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Treaties Getbytype

getTreaties
GET/treaties/getbytype{?datasource,type,exposuretype}

Retrieves a list of the treaties in a specified data source.

Example URI

GET /api/v1/treaties/getbytype?datasource=&type=&exposuretype=
URI Parameters
HideShow
datasource
string (optional) 

Name of the data source.

type
string (optional) 

Type of treaty.

exposuretype
string (optional) 

Type of exposure. Specify ‘POL’ for policy abd ‘LOC’ for location.

Response  200
HideShow

List of treaties retrieved.

Headers
Content-Type: application/json
Body
[
  {
    "treatyId": 1,
    "treatyNumber": "Hello, world!",
    "treatyName": "Hello, world!",
    "cedant": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "producer": {
      "id": "Hello, world!",
      "name": "Hello, world!"
    },
    "treatyType": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "currency": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "attachBasis": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "attachLevel": {
      "id": 1,
      "code": "Hello, world!",
      "name": "Hello, world!"
    },
    "premium": 1,
    "occurLimit": 1,
    "attachPt": 1,
    "riskLimit": 1,
    "retentAmt": 1,
    "pcntPlaced": 1,
    "effectDate": "Hello, world!",
    "expireDate": "Hello, world!",
    "pcntRetent": 1,
    "pcntRiShare": 1,
    "pcntCovered": 1,
    "priority": 1,
    "numOfReinst": 1,
    "reinstCharge": 1,
    "maolAmount": 1,
    "isValid": true,
    "userId1": "Hello, world!",
    "userId2": "Hello, world!",
    "lobs": [
      {
        "id": 1,
        "name": "Hello, world!"
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Generated by aglio on 21 Nov 2019